Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "generated/Endpoints"

Index

Interfaces

Type aliases

Type aliases

ActionsCancelWorkflowRunEndpoint

ActionsCancelWorkflowRunEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsCancelWorkflowRunRequestOptions

ActionsCancelWorkflowRunRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/cancel" }

Type declaration

ActionsCreateOrUpdateSecretForRepoEndpoint

ActionsCreateOrUpdateSecretForRepoEndpoint: { encrypted_value?: string; key_id?: string; name: string; owner: string; repo: string }

Type declaration

  • Optional encrypted_value?: string

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get your public key endpoint.

  • Optional key_id?: string

    ID of the key you used to encrypt the secret.

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsCreateOrUpdateSecretForRepoRequestOptions

ActionsCreateOrUpdateSecretForRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/:name" }

Type declaration

ActionsCreateRegistrationTokenEndpoint

ActionsCreateRegistrationTokenEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsCreateRegistrationTokenRequestOptions

ActionsCreateRegistrationTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/registration-token" }

Type declaration

ActionsCreateRegistrationTokenResponseData

ActionsCreateRegistrationTokenResponseData: { expires_at: string; token: string }

Type declaration

  • expires_at: string
  • token: string

ActionsCreateRemoveTokenEndpoint

ActionsCreateRemoveTokenEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsCreateRemoveTokenRequestOptions

ActionsCreateRemoveTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/remove-token" }

Type declaration

ActionsCreateRemoveTokenResponseData

ActionsCreateRemoveTokenResponseData: { expires_at: string; token: string }

Type declaration

  • expires_at: string
  • token: string

ActionsDeleteArtifactEndpoint

ActionsDeleteArtifactEndpoint: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number

    artifact_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsDeleteArtifactRequestOptions

ActionsDeleteArtifactRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts/:artifact_id" }

Type declaration

ActionsDeleteSecretFromRepoEndpoint

ActionsDeleteSecretFromRepoEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsDeleteSecretFromRepoRequestOptions

ActionsDeleteSecretFromRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/:name" }

Type declaration

ActionsDownloadArtifactEndpoint

ActionsDownloadArtifactEndpoint: { archive_format: string; artifact_id: number; owner: string; repo: string }

Type declaration

  • archive_format: string

    archive_format parameter

  • artifact_id: number

    artifact_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsDownloadArtifactRequestOptions

ActionsDownloadArtifactRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format" }

Type declaration

ActionsGetArtifactEndpoint

ActionsGetArtifactEndpoint: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number

    artifact_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetArtifactRequestOptions

ActionsGetArtifactRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts/:artifact_id" }

Type declaration

ActionsGetArtifactResponseData

ActionsGetArtifactResponseData: { archive_download_url: string; created_at: string; expired: boolean; expires_at: string; id: number; name: string; node_id: string; size_in_bytes: number; url: string }

Type declaration

  • archive_download_url: string
  • created_at: string
  • expired: boolean
  • expires_at: string
  • id: number
  • name: string
  • node_id: string
  • size_in_bytes: number
  • url: string

ActionsGetPublicKeyEndpoint

ActionsGetPublicKeyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetPublicKeyRequestOptions

ActionsGetPublicKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/public-key" }

Type declaration

ActionsGetPublicKeyResponseData

ActionsGetPublicKeyResponseData: { key: string; key_id: string }

Type declaration

  • key: string
  • key_id: string

ActionsGetSecretEndpoint

ActionsGetSecretEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetSecretRequestOptions

ActionsGetSecretRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/:name" }

Type declaration

ActionsGetSecretResponseData

ActionsGetSecretResponseData: { created_at: string; name: string; updated_at: string }

Type declaration

  • created_at: string
  • name: string
  • updated_at: string

ActionsGetSelfHostedRunnerEndpoint

ActionsGetSelfHostedRunnerEndpoint: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • runner_id: number

    runner_id parameter

ActionsGetSelfHostedRunnerRequestOptions

ActionsGetSelfHostedRunnerRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/:runner_id" }

Type declaration

ActionsGetSelfHostedRunnerResponseData

ActionsGetSelfHostedRunnerResponseData: { id: number; name: string; os: string; status: string }

Type declaration

  • id: number
  • name: string
  • os: string
  • status: string

ActionsGetWorkflowEndpoint

ActionsGetWorkflowEndpoint: { owner: string; repo: string; workflow_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • workflow_id: number

    workflow_id parameter

ActionsGetWorkflowJobEndpoint

ActionsGetWorkflowJobEndpoint: { job_id: number; owner: string; repo: string }

Type declaration

  • job_id: number

    job_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetWorkflowJobRequestOptions

ActionsGetWorkflowJobRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/jobs/:job_id" }

Type declaration

ActionsGetWorkflowJobResponseData

ActionsGetWorkflowJobResponseData: { check_run_url: string; completed_at: string; conclusion: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; run_id: number; run_url: string; started_at: string; status: string; steps: Array<ActionsGetWorkflowJobResponseDataStepsItem>; url: string }

Type declaration

  • check_run_url: string
  • completed_at: string
  • conclusion: string
  • head_sha: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • run_id: number
  • run_url: string
  • started_at: string
  • status: string
  • steps: Array<ActionsGetWorkflowJobResponseDataStepsItem>
  • url: string

ActionsGetWorkflowJobResponseDataStepsItem

ActionsGetWorkflowJobResponseDataStepsItem: { completed_at: string; conclusion: string; name: string; number: number; started_at: string; status: string }

Type declaration

  • completed_at: string
  • conclusion: string
  • name: string
  • number: number
  • started_at: string
  • status: string

ActionsGetWorkflowRequestOptions

ActionsGetWorkflowRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows/:workflow_id" }

Type declaration

ActionsGetWorkflowResponseData

ActionsGetWorkflowResponseData: { badge_url: string; created_at: string; html_url: string; id: number; name: string; node_id: string; path: string; state: string; updated_at: string; url: string }

Type declaration

  • badge_url: string
  • created_at: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • path: string
  • state: string
  • updated_at: string
  • url: string

ActionsGetWorkflowRunEndpoint

ActionsGetWorkflowRunEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsGetWorkflowRunRequestOptions

ActionsGetWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id" }

Type declaration

ActionsGetWorkflowRunResponseData

ActionsGetWorkflowRunResponseData: { artifacts_url: string; cancel_url: string; check_suite_url: string; conclusion: null; created_at: string; event: string; head_branch: string; head_commit: ActionsGetWorkflowRunResponseDataHeadCommit; head_repository: ActionsGetWorkflowRunResponseDataHeadRepository; head_sha: string; html_url: string; id: number; jobs_url: string; logs_url: string; node_id: string; pull_requests: Array<any>; repository: ActionsGetWorkflowRunResponseDataRepository; rerun_url: string; run_number: number; status: string; updated_at: string; url: string; workflow_url: string }

Type declaration

ActionsGetWorkflowRunResponseDataHeadCommit

ActionsGetWorkflowRunResponseDataHeadCommit: { author: ActionsGetWorkflowRunResponseDataHeadCommitAuthor; committer: ActionsGetWorkflowRunResponseDataHeadCommitCommitter; id: string; message: string; timestamp: string; tree_id: string }

Type declaration

ActionsGetWorkflowRunResponseDataHeadCommitAuthor

ActionsGetWorkflowRunResponseDataHeadCommitAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsGetWorkflowRunResponseDataHeadCommitCommitter

ActionsGetWorkflowRunResponseDataHeadCommitCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsGetWorkflowRunResponseDataHeadRepository

ActionsGetWorkflowRunResponseDataHeadRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: null; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsGetWorkflowRunResponseDataHeadRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: null
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsGetWorkflowRunResponseDataHeadRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsGetWorkflowRunResponseDataHeadRepositoryOwner

ActionsGetWorkflowRunResponseDataHeadRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsGetWorkflowRunResponseDataRepository

ActionsGetWorkflowRunResponseDataRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsGetWorkflowRunResponseDataRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsGetWorkflowRunResponseDataRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsGetWorkflowRunResponseDataRepositoryOwner

ActionsGetWorkflowRunResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListArtifactsForRepoEndpoint

ActionsListArtifactsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListArtifactsForRepoRequestOptions

ActionsListArtifactsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts" }

Type declaration

ActionsListArtifactsForRepoResponseData

ActionsListArtifactsForRepoResponseData: { artifacts: Array<ActionsListArtifactsForRepoResponseDataArtifactsItem>; total_count: number }

Type declaration

ActionsListArtifactsForRepoResponseDataArtifactsItem

ActionsListArtifactsForRepoResponseDataArtifactsItem: { archive_download_url: string; created_at: string; expired: boolean; expires_at: string; id: number; name: string; node_id: string; size_in_bytes: number; url: string }

Type declaration

  • archive_download_url: string
  • created_at: string
  • expired: boolean
  • expires_at: string
  • id: number
  • name: string
  • node_id: string
  • size_in_bytes: number
  • url: string

ActionsListDownloadsForSelfHostedRunnerApplicationEndpoint

ActionsListDownloadsForSelfHostedRunnerApplicationEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsListDownloadsForSelfHostedRunnerApplicationRequestOptions

ActionsListDownloadsForSelfHostedRunnerApplicationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/downloads" }

Type declaration

ActionsListDownloadsForSelfHostedRunnerApplicationResponseData

ActionsListDownloadsForSelfHostedRunnerApplicationResponseData: Array<ActionsListDownloadsForSelfHostedRunnerApplicationResponseDataItem>

ActionsListDownloadsForSelfHostedRunnerApplicationResponseDataItem

ActionsListDownloadsForSelfHostedRunnerApplicationResponseDataItem: { architecture: string; download_url: string; filename: string; os: string }

Type declaration

  • architecture: string
  • download_url: string
  • filename: string
  • os: string

ActionsListJobsForWorkflowRunEndpoint

ActionsListJobsForWorkflowRunEndpoint: { filter?: "latest" | "all"; owner: string; page?: number; per_page?: number; repo: string; run_id: number }

Type declaration

  • Optional filter?: "latest" | "all"

    Filters jobs by their completed_at timestamp. Can be one of: * latest: Returns jobs from the most recent execution of the workflow run. * all: Returns all jobs for a workflow run, including from old executions of the workflow run.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsListJobsForWorkflowRunRequestOptions

ActionsListJobsForWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/jobs" }

Type declaration

ActionsListJobsForWorkflowRunResponseData

ActionsListJobsForWorkflowRunResponseData: { jobs: Array<ActionsListJobsForWorkflowRunResponseDataJobsItem>; total_count: number }

Type declaration

ActionsListJobsForWorkflowRunResponseDataJobsItem

ActionsListJobsForWorkflowRunResponseDataJobsItem: { check_run_url: string; completed_at: string; conclusion: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; run_id: number; run_url: string; started_at: string; status: string; steps: Array<ActionsListJobsForWorkflowRunResponseDataJobsItemStepsItem>; url: string }

Type declaration

ActionsListJobsForWorkflowRunResponseDataJobsItemStepsItem

ActionsListJobsForWorkflowRunResponseDataJobsItemStepsItem: { completed_at: string; conclusion: string; name: string; number: number; started_at: string; status: string }

Type declaration

  • completed_at: string
  • conclusion: string
  • name: string
  • number: number
  • started_at: string
  • status: string

ActionsListRepoWorkflowRunsEndpoint

ActionsListRepoWorkflowRunsEndpoint: { actor?: string; branch?: string; event?: string; owner: string; page?: number; per_page?: number; repo: string; status?: "completed" | "status" | "conclusion" }

Type declaration

  • Optional actor?: string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

ActionsListRepoWorkflowRunsRequestOptions

ActionsListRepoWorkflowRunsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs" }

Type declaration

ActionsListRepoWorkflowRunsResponseData

ActionsListRepoWorkflowRunsResponseData: { total_count: number; workflow_runs: Array<ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItem> }

Type declaration

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItem

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItem: { artifacts_url: string; cancel_url: string; check_suite_url: string; conclusion: null; created_at: string; event: string; head_branch: string; head_commit: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit; head_repository: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository; head_sha: string; html_url: string; id: number; jobs_url: string; logs_url: string; node_id: string; pull_requests: Array<any>; repository: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository; rerun_url: string; run_number: number; status: string; updated_at: string; url: string; workflow_url: string }

Type declaration

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit: { author: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor; committer: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter; id: string; message: string; timestamp: string; tree_id: string }

Type declaration

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: null; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: null
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListRepoWorkflowsEndpoint

ActionsListRepoWorkflowsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListRepoWorkflowsRequestOptions

ActionsListRepoWorkflowsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows" }

Type declaration

ActionsListRepoWorkflowsResponseData

ActionsListRepoWorkflowsResponseData: { total_count: number; workflows: Array<ActionsListRepoWorkflowsResponseDataWorkflowsItem> }

Type declaration

ActionsListRepoWorkflowsResponseDataWorkflowsItem

ActionsListRepoWorkflowsResponseDataWorkflowsItem: { badge_url: string; created_at: string; html_url: string; id: number; name: string; node_id: string; path: string; state: string; updated_at: string; url: string }

Type declaration

  • badge_url: string
  • created_at: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • path: string
  • state: string
  • updated_at: string
  • url: string

ActionsListSecretsForRepoEndpoint

ActionsListSecretsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListSecretsForRepoRequestOptions

ActionsListSecretsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets" }

Type declaration

ActionsListSecretsForRepoResponseData

ActionsListSecretsForRepoResponseData: { secrets: Array<ActionsListSecretsForRepoResponseDataSecretsItem>; total_count: number }

Type declaration

ActionsListSecretsForRepoResponseDataSecretsItem

ActionsListSecretsForRepoResponseDataSecretsItem: { created_at: string; name: string; updated_at: string }

Type declaration

  • created_at: string
  • name: string
  • updated_at: string

ActionsListSelfHostedRunnersForRepoEndpoint

ActionsListSelfHostedRunnersForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListSelfHostedRunnersForRepoRequestOptions

ActionsListSelfHostedRunnersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners" }

Type declaration

ActionsListSelfHostedRunnersForRepoResponseData

ActionsListSelfHostedRunnersForRepoResponseData: { runners: Array<ActionsListSelfHostedRunnersForRepoResponseDataRunnersItem>; total_count: number }

Type declaration

ActionsListSelfHostedRunnersForRepoResponseDataRunnersItem

ActionsListSelfHostedRunnersForRepoResponseDataRunnersItem: { id: number; name: string; os: string; status: string }

Type declaration

  • id: number
  • name: string
  • os: string
  • status: string

ActionsListWorkflowJobLogsEndpoint

ActionsListWorkflowJobLogsEndpoint: { job_id: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • job_id: number

    job_id parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListWorkflowJobLogsRequestOptions

ActionsListWorkflowJobLogsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/jobs/:job_id/logs" }

Type declaration

ActionsListWorkflowRunArtifactsEndpoint

ActionsListWorkflowRunArtifactsEndpoint: { owner: string; page?: number; per_page?: number; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsListWorkflowRunArtifactsRequestOptions

ActionsListWorkflowRunArtifactsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts" }

Type declaration

ActionsListWorkflowRunArtifactsResponseData

ActionsListWorkflowRunArtifactsResponseData: { artifacts: Array<ActionsListWorkflowRunArtifactsResponseDataArtifactsItem>; total_count: number }

Type declaration

ActionsListWorkflowRunArtifactsResponseDataArtifactsItem

ActionsListWorkflowRunArtifactsResponseDataArtifactsItem: { archive_download_url: string; created_at: string; expired: boolean; expires_at: string; id: number; name: string; node_id: string; size_in_bytes: number; url: string }

Type declaration

  • archive_download_url: string
  • created_at: string
  • expired: boolean
  • expires_at: string
  • id: number
  • name: string
  • node_id: string
  • size_in_bytes: number
  • url: string

ActionsListWorkflowRunLogsEndpoint

ActionsListWorkflowRunLogsEndpoint: { owner: string; page?: number; per_page?: number; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsListWorkflowRunLogsRequestOptions

ActionsListWorkflowRunLogsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/logs" }

Type declaration

ActionsListWorkflowRunsEndpoint

ActionsListWorkflowRunsEndpoint: { actor?: string; branch?: string; event?: string; owner: string; page?: number; per_page?: number; repo: string; status?: "completed" | "status" | "conclusion"; workflow_id: number }

Type declaration

  • Optional actor?: string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

  • workflow_id: number

    workflow_id parameter

ActionsListWorkflowRunsRequestOptions

ActionsListWorkflowRunsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs" }

Type declaration

ActionsListWorkflowRunsResponseData

ActionsListWorkflowRunsResponseData: { total_count: number; workflow_runs: Array<ActionsListWorkflowRunsResponseDataWorkflowRunsItem> }

Type declaration

ActionsListWorkflowRunsResponseDataWorkflowRunsItem

ActionsListWorkflowRunsResponseDataWorkflowRunsItem: { artifacts_url: string; cancel_url: string; check_suite_url: string; conclusion: null; created_at: string; event: string; head_branch: string; head_commit: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit; head_repository: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository; head_sha: string; html_url: string; id: number; jobs_url: string; logs_url: string; node_id: string; pull_requests: Array<any>; repository: ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository; rerun_url: string; run_number: number; status: string; updated_at: string; url: string; workflow_url: string }

Type declaration

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit: { author: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor; committer: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter; id: string; message: string; timestamp: string; tree_id: string }

Type declaration

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: null; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: null
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsReRunWorkflowEndpoint

ActionsReRunWorkflowEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsReRunWorkflowRequestOptions

ActionsReRunWorkflowRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/rerun" }

Type declaration

ActionsRemoveSelfHostedRunnerEndpoint

ActionsRemoveSelfHostedRunnerEndpoint: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • runner_id: number

    runner_id parameter

ActionsRemoveSelfHostedRunnerRequestOptions

ActionsRemoveSelfHostedRunnerRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/:runner_id" }

Type declaration

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/starred/:owner/:repo" }

Type declaration

ActivityCheckWatchingRepoLegacyEndpoint

ActivityCheckWatchingRepoLegacyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityCheckWatchingRepoLegacyRequestOptions

ActivityCheckWatchingRepoLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/subscriptions/:owner/:repo" }

Type declaration

ActivityDeleteRepoSubscriptionEndpoint

ActivityDeleteRepoSubscriptionEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityDeleteRepoSubscriptionRequestOptions

ActivityDeleteRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscription" }

Type declaration

ActivityDeleteThreadSubscriptionEndpoint

ActivityDeleteThreadSubscriptionEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityDeleteThreadSubscriptionRequestOptions

ActivityDeleteThreadSubscriptionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id/subscription" }

Type declaration

ActivityGetFeedsEndpoint

ActivityGetFeedsEndpoint: {}

Type declaration

ActivityGetFeedsRequestOptions

ActivityGetFeedsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/feeds" }

Type declaration

ActivityGetFeedsResponseData

ActivityGetFeedsResponseData: { _links: ActivityGetFeedsResponseDataLinks; current_user_actor_url: string; current_user_organization_url: string; current_user_organization_urls: Array<string>; current_user_public_url: string; current_user_url: string; security_advisories_url: string; timeline_url: string; user_url: string }

Type declaration

  • _links: ActivityGetFeedsResponseDataLinks
  • current_user_actor_url: string
  • current_user_organization_url: string
  • current_user_organization_urls: Array<string>
  • current_user_public_url: string
  • current_user_url: string
  • security_advisories_url: string
  • timeline_url: string
  • user_url: string

ActivityGetFeedsResponseDataLinks

ActivityGetFeedsResponseDataLinks: { current_user: ActivityGetFeedsResponseDataLinksCurrentUser; current_user_actor: ActivityGetFeedsResponseDataLinksCurrentUserActor; current_user_organization: ActivityGetFeedsResponseDataLinksCurrentUserOrganization; current_user_organizations: Array<ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem>; current_user_public: ActivityGetFeedsResponseDataLinksCurrentUserPublic; security_advisories: ActivityGetFeedsResponseDataLinksSecurityAdvisories; timeline: ActivityGetFeedsResponseDataLinksTimeline; user: ActivityGetFeedsResponseDataLinksUser }

Type declaration

ActivityGetFeedsResponseDataLinksCurrentUser

ActivityGetFeedsResponseDataLinksCurrentUser: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetFeedsResponseDataLinksCurrentUserActor

ActivityGetFeedsResponseDataLinksCurrentUserActor: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetFeedsResponseDataLinksCurrentUserOrganization

ActivityGetFeedsResponseDataLinksCurrentUserOrganization: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem

ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetFeedsResponseDataLinksCurrentUserPublic

ActivityGetFeedsResponseDataLinksCurrentUserPublic: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetFeedsResponseDataLinksSecurityAdvisories

ActivityGetFeedsResponseDataLinksSecurityAdvisories: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetFeedsResponseDataLinksTimeline

ActivityGetFeedsResponseDataLinksTimeline: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetFeedsResponseDataLinksUser

ActivityGetFeedsResponseDataLinksUser: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityGetRepoSubscriptionEndpoint

ActivityGetRepoSubscriptionEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityGetRepoSubscriptionRequestOptions

ActivityGetRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscription" }

Type declaration

ActivityGetRepoSubscriptionResponseData

ActivityGetRepoSubscriptionResponseData: { created_at: string; ignored: boolean; reason: null; repository_url: string; subscribed: boolean; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • repository_url: string
  • subscribed: boolean
  • url: string

ActivityGetThreadEndpoint

ActivityGetThreadEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityGetThreadRequestOptions

ActivityGetThreadRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id" }

Type declaration

ActivityGetThreadResponseData

ActivityGetThreadResponseData: { id: string; last_read_at: string; reason: string; repository: ActivityGetThreadResponseDataRepository; subject: ActivityGetThreadResponseDataSubject; unread: boolean; updated_at: string; url: string }

Type declaration

ActivityGetThreadResponseDataRepository

ActivityGetThreadResponseDataRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActivityGetThreadResponseDataRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActivityGetThreadResponseDataRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityGetThreadResponseDataRepositoryOwner

ActivityGetThreadResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityGetThreadResponseDataSubject

ActivityGetThreadResponseDataSubject: { latest_comment_url: string; title: string; type: string; url: string }

Type declaration

  • latest_comment_url: string
  • title: string
  • type: string
  • url: string

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id/subscription" }

Type declaration

ActivityGetThreadSubscriptionForAuthenticatedUserResponseData

ActivityGetThreadSubscriptionForAuthenticatedUserResponseData: { created_at: string; ignored: boolean; reason: null; subscribed: boolean; thread_url: string; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • subscribed: boolean
  • thread_url: string
  • url: string

ActivityListEventsForAuthenticatedUserEndpoint

ActivityListEventsForAuthenticatedUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListEventsForAuthenticatedUserRequestOptions

ActivityListEventsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/events" }

Type declaration

ActivityListNotificationsForAuthenticatedUserEndpoint

ActivityListNotificationsForAuthenticatedUserEndpoint: { all?: boolean; before?: string; page?: number; participating?: boolean; per_page?: number; since?: string }

Type declaration

  • Optional all?: boolean

    If true, show notifications marked as read.

  • Optional before?: string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional participating?: boolean

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListNotificationsForAuthenticatedUserRequestOptions

ActivityListNotificationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/notifications" }

Type declaration

ActivityListNotificationsForAuthenticatedUserResponseData

ActivityListNotificationsForAuthenticatedUserResponseData: Array<ActivityListNotificationsForAuthenticatedUserResponseDataItem>

ActivityListNotificationsForAuthenticatedUserResponseDataItem

ActivityListNotificationsForAuthenticatedUserResponseDataItem: { id: string; last_read_at: string; reason: string; repository: ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository; subject: ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject; unread: boolean; updated_at: string; url: string }

Type declaration

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject

ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject: { latest_comment_url: string; title: string; type: string; url: string }

Type declaration

  • latest_comment_url: string
  • title: string
  • type: string
  • url: string

ActivityListOrgEventsForAuthenticatedUserEndpoint

ActivityListOrgEventsForAuthenticatedUserEndpoint: { org: string; page?: number; per_page?: number; username: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListOrgEventsForAuthenticatedUserRequestOptions

ActivityListOrgEventsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/events/orgs/:org" }

Type declaration

ActivityListPublicEventsEndpoint

ActivityListPublicEventsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ActivityListPublicEventsForRepoNetworkEndpoint

ActivityListPublicEventsForRepoNetworkEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListPublicEventsForRepoNetworkRequestOptions

ActivityListPublicEventsForRepoNetworkRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/networks/:owner/:repo/events" }

Type declaration

ActivityListPublicEventsForUserEndpoint

ActivityListPublicEventsForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListPublicEventsForUserRequestOptions

ActivityListPublicEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/events/public" }

Type declaration

ActivityListPublicEventsRequestOptions

ActivityListPublicEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/events" }

Type declaration

ActivityListPublicOrgEventsEndpoint

ActivityListPublicOrgEventsEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ActivityListPublicOrgEventsRequestOptions

ActivityListPublicOrgEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/events" }

Type declaration

ActivityListReceivedEventsForUserEndpoint

ActivityListReceivedEventsForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListReceivedEventsForUserRequestOptions

ActivityListReceivedEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/received_events" }

Type declaration

ActivityListReceivedPublicEventsForUserEndpoint

ActivityListReceivedPublicEventsForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListReceivedPublicEventsForUserRequestOptions

ActivityListReceivedPublicEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/received_events/public" }

Type declaration

ActivityListRepoEventsEndpoint

ActivityListRepoEventsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListRepoEventsRequestOptions

ActivityListRepoEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/events" }

Type declaration

ActivityListRepoNotificationsForAuthenticatedUserEndpoint

ActivityListRepoNotificationsForAuthenticatedUserEndpoint: { all?: boolean; before?: string; owner: string; page?: number; participating?: boolean; per_page?: number; repo: string; since?: string }

Type declaration

  • Optional all?: boolean

    If true, show notifications marked as read.

  • Optional before?: string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional participating?: boolean

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/notifications" }

Type declaration

ActivityListRepoNotificationsForAuthenticatedUserResponseData

ActivityListRepoNotificationsForAuthenticatedUserResponseData: Array<ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem>

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem: { id: string; last_read_at: string; reason: string; repository: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository; subject: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject; unread: boolean; updated_at: string; url: string }

Type declaration

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject: { latest_comment_url: string; title: string; type: string; url: string }

Type declaration

  • latest_comment_url: string
  • title: string
  • type: string
  • url: string

ActivityListReposStarredByAuthenticatedUserEndpoint

ActivityListReposStarredByAuthenticatedUserEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

ActivityListReposStarredByAuthenticatedUserRequestOptions

ActivityListReposStarredByAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/starred" }

Type declaration

ActivityListReposStarredByAuthenticatedUserResponseData

ActivityListReposStarredByAuthenticatedUserResponseData: Array<ActivityListReposStarredByAuthenticatedUserResponseDataItem>

ActivityListReposStarredByAuthenticatedUserResponseDataItem

ActivityListReposStarredByAuthenticatedUserResponseDataItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner; permissions: ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner
  • permissions: ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner

ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions

ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListReposStarredByUserEndpoint

ActivityListReposStarredByUserEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated"; username: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

  • username: string

    username parameter

ActivityListReposStarredByUserRequestOptions

ActivityListReposStarredByUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/starred" }

Type declaration

ActivityListReposStarredByUserResponseData

ActivityListReposStarredByUserResponseData: Array<ActivityListReposStarredByUserResponseDataItem>

ActivityListReposStarredByUserResponseDataItem

ActivityListReposStarredByUserResponseDataItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListReposStarredByUserResponseDataItemOwner; permissions: ActivityListReposStarredByUserResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListReposStarredByUserResponseDataItemOwner
  • permissions: ActivityListReposStarredByUserResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListReposStarredByUserResponseDataItemOwner

ActivityListReposStarredByUserResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListReposStarredByUserResponseDataItemPermissions

ActivityListReposStarredByUserResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListReposWatchedByUserEndpoint

ActivityListReposWatchedByUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListReposWatchedByUserRequestOptions

ActivityListReposWatchedByUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/subscriptions" }

Type declaration

ActivityListReposWatchedByUserResponseData

ActivityListReposWatchedByUserResponseData: Array<ActivityListReposWatchedByUserResponseDataItem>

ActivityListReposWatchedByUserResponseDataItem

ActivityListReposWatchedByUserResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ActivityListReposWatchedByUserResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListReposWatchedByUserResponseDataItemOwner; permissions: ActivityListReposWatchedByUserResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: ActivityListReposWatchedByUserResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListReposWatchedByUserResponseDataItemOwner
  • permissions: ActivityListReposWatchedByUserResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListReposWatchedByUserResponseDataItemLicense

ActivityListReposWatchedByUserResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ActivityListReposWatchedByUserResponseDataItemOwner

ActivityListReposWatchedByUserResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListReposWatchedByUserResponseDataItemPermissions

ActivityListReposWatchedByUserResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListStargazersForRepoEndpoint

ActivityListStargazersForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListStargazersForRepoRequestOptions

ActivityListStargazersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stargazers" }

Type declaration

ActivityListStargazersForRepoResponseData

ActivityListStargazersForRepoResponseData: Array<ActivityListStargazersForRepoResponseDataItem>

ActivityListStargazersForRepoResponseDataItem

ActivityListStargazersForRepoResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListWatchedReposForAuthenticatedUserEndpoint

ActivityListWatchedReposForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ActivityListWatchedReposForAuthenticatedUserRequestOptions

ActivityListWatchedReposForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/subscriptions" }

Type declaration

ActivityListWatchedReposForAuthenticatedUserResponseData

ActivityListWatchedReposForAuthenticatedUserResponseData: Array<ActivityListWatchedReposForAuthenticatedUserResponseDataItem>

ActivityListWatchedReposForAuthenticatedUserResponseDataItem

ActivityListWatchedReposForAuthenticatedUserResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner; permissions: ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner
  • permissions: ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense

ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner

ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions

ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListWatchersForRepoEndpoint

ActivityListWatchersForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListWatchersForRepoRequestOptions

ActivityListWatchersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscribers" }

Type declaration

ActivityListWatchersForRepoResponseData

ActivityListWatchersForRepoResponseData: Array<ActivityListWatchersForRepoResponseDataItem>

ActivityListWatchersForRepoResponseDataItem

ActivityListWatchersForRepoResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityMarkNotificationsAsReadEndpoint

ActivityMarkNotificationsAsReadEndpoint: { last_read_at?: string }

Type declaration

  • Optional last_read_at?: string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

ActivityMarkNotificationsAsReadRequestOptions

ActivityMarkNotificationsAsReadRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/notifications" }

Type declaration

ActivityMarkRepoNotificationsAsReadEndpoint

ActivityMarkRepoNotificationsAsReadEndpoint: { last_read_at?: string; owner: string; repo: string }

Type declaration

  • Optional last_read_at?: string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityMarkRepoNotificationsAsReadRequestOptions

ActivityMarkRepoNotificationsAsReadRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/notifications" }

Type declaration

ActivityMarkThreadAsReadEndpoint

ActivityMarkThreadAsReadEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityMarkThreadAsReadRequestOptions

ActivityMarkThreadAsReadRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id" }

Type declaration

ActivitySetRepoSubscriptionEndpoint

ActivitySetRepoSubscriptionEndpoint: { ignored?: boolean; owner: string; repo: string; subscribed?: boolean }

Type declaration

  • Optional ignored?: boolean

    Determines if all notifications should be blocked from this repository.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional subscribed?: boolean

    Determines if notifications should be received from this repository.

ActivitySetRepoSubscriptionRequestOptions

ActivitySetRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscription" }

Type declaration

ActivitySetRepoSubscriptionResponseData

ActivitySetRepoSubscriptionResponseData: { created_at: string; ignored: boolean; reason: null; repository_url: string; subscribed: boolean; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • repository_url: string
  • subscribed: boolean
  • url: string

ActivitySetThreadSubscriptionEndpoint

ActivitySetThreadSubscriptionEndpoint: { ignored?: boolean; thread_id: number }

Type declaration

  • Optional ignored?: boolean

    Unsubscribes and subscribes you to a conversation. Set ignored to true to block all notifications from this thread.

  • thread_id: number

    thread_id parameter

ActivitySetThreadSubscriptionRequestOptions

ActivitySetThreadSubscriptionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id/subscription" }

Type declaration

ActivitySetThreadSubscriptionResponseData

ActivitySetThreadSubscriptionResponseData: { created_at: string; ignored: boolean; reason: null; subscribed: boolean; thread_url: string; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • subscribed: boolean
  • thread_url: string
  • url: string

ActivityStarRepoForAuthenticatedUserEndpoint

ActivityStarRepoForAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityStarRepoForAuthenticatedUserRequestOptions

ActivityStarRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/starred/:owner/:repo" }

Type declaration

ActivityStopWatchingRepoLegacyEndpoint

ActivityStopWatchingRepoLegacyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityStopWatchingRepoLegacyRequestOptions

ActivityStopWatchingRepoLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/subscriptions/:owner/:repo" }

Type declaration

ActivityUnstarRepoForAuthenticatedUserEndpoint

ActivityUnstarRepoForAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityUnstarRepoForAuthenticatedUserRequestOptions

ActivityUnstarRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/starred/:owner/:repo" }

Type declaration

ActivityWatchRepoLegacyEndpoint

ActivityWatchRepoLegacyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityWatchRepoLegacyRequestOptions

ActivityWatchRepoLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/subscriptions/:owner/:repo" }

Type declaration

AppsAddRepoToInstallationEndpoint

AppsAddRepoToInstallationEndpoint: { installation_id: number; repository_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

  • repository_id: number

    repository_id parameter

AppsAddRepoToInstallationRequestOptions

AppsAddRepoToInstallationRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/installations/:installation_id/repositories/:repository_id" }

Type declaration

AppsCheckAuthorizationEndpoint

AppsCheckAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsCheckAuthorizationRequestOptions

AppsCheckAuthorizationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/applications/:client_id/tokens/:access_token" }

Type declaration

AppsCheckAuthorizationResponseData

AppsCheckAuthorizationResponseData: { app: AppsCheckAuthorizationResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsCheckAuthorizationResponseDataUser }

Type declaration

AppsCheckAuthorizationResponseDataApp

AppsCheckAuthorizationResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

AppsCheckAuthorizationResponseDataUser

AppsCheckAuthorizationResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsCheckTokenEndpoint

AppsCheckTokenEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsCheckTokenRequestOptions

AppsCheckTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/applications/:client_id/token" }

Type declaration

AppsCheckTokenResponseData

AppsCheckTokenResponseData: { app: AppsCheckTokenResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsCheckTokenResponseDataUser }

Type declaration

AppsCheckTokenResponseDataApp

AppsCheckTokenResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

AppsCheckTokenResponseDataUser

AppsCheckTokenResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsCreateContentAttachmentEndpoint

AppsCreateContentAttachmentEndpoint: { body: string; content_reference_id: number; title: string }

Type declaration

  • body: string

    The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.

  • content_reference_id: number

    content_reference_id parameter

  • title: string

    The title of the content attachment displayed in the body or comment of an issue or pull request.

AppsCreateContentAttachmentRequestOptions

AppsCreateContentAttachmentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/content_references/:content_reference_id/attachments" }

Type declaration

AppsCreateContentAttachmentResponseData

AppsCreateContentAttachmentResponseData: { body: string; id: number; title: string }

Type declaration

  • body: string
  • id: number
  • title: string

AppsCreateFromManifestEndpoint

AppsCreateFromManifestEndpoint: { code: string }

Type declaration

  • code: string

    code parameter

AppsCreateFromManifestRequestOptions

AppsCreateFromManifestRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/app-manifests/:code/conversions" }

Type declaration

AppsCreateFromManifestResponseData

AppsCreateFromManifestResponseData: { client_id: string; client_secret: string; created_at: string; description: null; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: AppsCreateFromManifestResponseDataOwner; pem: string; updated_at: string; webhook_secret: string }

Type declaration

  • client_id: string
  • client_secret: string
  • created_at: string
  • description: null
  • external_url: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • owner: AppsCreateFromManifestResponseDataOwner
  • pem: string
  • updated_at: string
  • webhook_secret: string

AppsCreateFromManifestResponseDataOwner

AppsCreateFromManifestResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsCreateInstallationTokenEndpoint

AppsCreateInstallationTokenEndpoint: { installation_id: number; permissions?: AppsCreateInstallationTokenParamsPermissions; repository_ids?: number[] }

Type declaration

  • installation_id: number

    installation_id parameter

  • Optional permissions?: AppsCreateInstallationTokenParamsPermissions

    The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "GitHub App permissions."

  • Optional repository_ids?: number[]

    The ids of the repositories that the installation token can access. Providing repository ids restricts the access of an installation token to specific repositories. You can use the "List repositories" endpoint to get the id of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.

AppsCreateInstallationTokenParamsPermissions

AppsCreateInstallationTokenParamsPermissions: {}

Type declaration

AppsCreateInstallationTokenRequestOptions

AppsCreateInstallationTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/app/installations/:installation_id/access_tokens" }

Type declaration

AppsCreateInstallationTokenResponseData

AppsCreateInstallationTokenResponseData: { expires_at: string; permissions: AppsCreateInstallationTokenResponseDataPermissions; repositories: Array<AppsCreateInstallationTokenResponseDataRepositoriesItem>; token: string }

Type declaration

AppsCreateInstallationTokenResponseDataPermissions

AppsCreateInstallationTokenResponseDataPermissions: { contents: string; issues: string }

Type declaration

  • contents: string
  • issues: string

AppsCreateInstallationTokenResponseDataRepositoriesItem

AppsCreateInstallationTokenResponseDataRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: AppsCreateInstallationTokenResponseDataRepositoriesItemOwner; permissions: AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: AppsCreateInstallationTokenResponseDataRepositoriesItemOwner
  • permissions: AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

AppsCreateInstallationTokenResponseDataRepositoriesItemOwner

AppsCreateInstallationTokenResponseDataRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions

AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

AppsDeleteAuthorizationEndpoint

AppsDeleteAuthorizationEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsDeleteAuthorizationRequestOptions

AppsDeleteAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/grant" }

Type declaration

AppsDeleteInstallationEndpoint

AppsDeleteInstallationEndpoint: { installation_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

AppsDeleteInstallationRequestOptions

AppsDeleteInstallationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/app/installations/:installation_id" }

Type declaration

AppsDeleteTokenEndpoint

AppsDeleteTokenEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsDeleteTokenRequestOptions

AppsDeleteTokenRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/token" }

Type declaration

AppsGetAuthenticatedEndpoint

AppsGetAuthenticatedEndpoint: {}

Type declaration

AppsGetAuthenticatedRequestOptions

AppsGetAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/app" }

Type declaration

AppsGetAuthenticatedResponseData

AppsGetAuthenticatedResponseData: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; installations_count: number; name: string; node_id: string; owner: AppsGetAuthenticatedResponseDataOwner; permissions: AppsGetAuthenticatedResponseDataPermissions; slug: string; updated_at: string }

Type declaration

AppsGetAuthenticatedResponseDataOwner

AppsGetAuthenticatedResponseDataOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

AppsGetAuthenticatedResponseDataPermissions

AppsGetAuthenticatedResponseDataPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

AppsGetBySlugEndpoint

AppsGetBySlugEndpoint: { app_slug: string }

Type declaration

  • app_slug: string

    app_slug parameter

AppsGetBySlugRequestOptions

AppsGetBySlugRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/apps/:app_slug" }

Type declaration

AppsGetBySlugResponseData

AppsGetBySlugResponseData: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: AppsGetBySlugResponseDataOwner; permissions: AppsGetBySlugResponseDataPermissions; slug: string; updated_at: string }

Type declaration

AppsGetBySlugResponseDataOwner

AppsGetBySlugResponseDataOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

AppsGetBySlugResponseDataPermissions

AppsGetBySlugResponseDataPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

AppsGetInstallationEndpoint

AppsGetInstallationEndpoint: { installation_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

AppsGetInstallationRequestOptions

AppsGetInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/app/installations/:installation_id" }

Type declaration

AppsGetInstallationResponseData

AppsGetInstallationResponseData: { access_tokens_url: string; account: AppsGetInstallationResponseDataAccount; app_id: number; events: Array<string>; html_url: string; id: number; permissions: AppsGetInstallationResponseDataPermissions; repositories_url: string; repository_selection: string; single_file_name: string; target_id: number; target_type: string }

Type declaration

AppsGetInstallationResponseDataAccount

AppsGetInstallationResponseDataAccount: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

AppsGetInstallationResponseDataPermissions

AppsGetInstallationResponseDataPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

AppsGetOrgInstallationEndpoint

AppsGetOrgInstallationEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

AppsGetOrgInstallationRequestOptions

AppsGetOrgInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/installation" }

Type declaration

AppsGetOrgInstallationResponseData

AppsGetOrgInstallationResponseData: { access_tokens_url: string; account: AppsGetOrgInstallationResponseDataAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsGetOrgInstallationResponseDataPermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

Type declaration

AppsGetOrgInstallationResponseDataAccount

AppsGetOrgInstallationResponseDataAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsGetOrgInstallationResponseDataPermissions

AppsGetOrgInstallationResponseDataPermissions: { checks: string; contents: string; metadata: string }

Type declaration

  • checks: string
  • contents: string
  • metadata: string

AppsGetRepoInstallationEndpoint

AppsGetRepoInstallationEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

AppsGetRepoInstallationRequestOptions

AppsGetRepoInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/installation" }

Type declaration

AppsGetRepoInstallationResponseData

AppsGetRepoInstallationResponseData: { access_tokens_url: string; account: AppsGetRepoInstallationResponseDataAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsGetRepoInstallationResponseDataPermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

Type declaration

AppsGetRepoInstallationResponseDataAccount

AppsGetRepoInstallationResponseDataAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsGetRepoInstallationResponseDataPermissions

AppsGetRepoInstallationResponseDataPermissions: { checks: string; contents: string; metadata: string }

Type declaration

  • checks: string
  • contents: string
  • metadata: string

AppsGetSubscriptionPlanForAccountEndpoint

AppsGetSubscriptionPlanForAccountEndpoint: { account_id: number }

Type declaration

  • account_id: number

    account_id parameter

AppsGetSubscriptionPlanForAccountRequestOptions

AppsGetSubscriptionPlanForAccountRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/accounts/:account_id" }

Type declaration

AppsGetSubscriptionPlanForAccountResponseData

AppsGetSubscriptionPlanForAccountResponseData: { email: null; id: number; login: string; marketplace_pending_change: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange; marketplace_purchase: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase; organization_billing_email: string; type: string; url: string }

Type declaration

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange: { effective_date: string; id: number; plan: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan; unit_count: null }

Type declaration

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan; unit_count: null; updated_at: string }

Type declaration

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsGetSubscriptionPlanForAccountStubbedEndpoint

AppsGetSubscriptionPlanForAccountStubbedEndpoint: { account_id: number }

Type declaration

  • account_id: number

    account_id parameter

AppsGetSubscriptionPlanForAccountStubbedRequestOptions

AppsGetSubscriptionPlanForAccountStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/stubbed/accounts/:account_id" }

Type declaration

AppsGetSubscriptionPlanForAccountStubbedResponseData

AppsGetSubscriptionPlanForAccountStubbedResponseData: { email: null; id: number; login: string; marketplace_pending_change: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange; marketplace_purchase: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase; organization_billing_email: string; type: string; url: string }

Type declaration

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange: { effective_date: string; id: number; plan: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan; unit_count: null }

Type declaration

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan; unit_count: null; updated_at: string }

Type declaration

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsGetUserInstallationEndpoint

AppsGetUserInstallationEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

AppsGetUserInstallationRequestOptions

AppsGetUserInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/installation" }

Type declaration

AppsGetUserInstallationResponseData

AppsGetUserInstallationResponseData: { access_tokens_url: string; account: AppsGetUserInstallationResponseDataAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsGetUserInstallationResponseDataPermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

Type declaration

AppsGetUserInstallationResponseDataAccount

AppsGetUserInstallationResponseDataAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsGetUserInstallationResponseDataPermissions

AppsGetUserInstallationResponseDataPermissions: { checks: string; contents: string; metadata: string }

Type declaration

  • checks: string
  • contents: string
  • metadata: string

AppsListAccountsForPlanEndpoint

AppsListAccountsForPlanEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • plan_id: number

    plan_id parameter

  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsForPlanRequestOptions

AppsListAccountsForPlanRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/plans/:plan_id/accounts" }

Type declaration

AppsListAccountsForPlanResponseData

AppsListAccountsForPlanResponseData: Array<AppsListAccountsForPlanResponseDataItem>

AppsListAccountsForPlanResponseDataItem

AppsListAccountsForPlanResponseDataItem: { email: null; id: number; login: string; marketplace_pending_change: AppsListAccountsForPlanResponseDataItemMarketplacePendingChange; marketplace_purchase: AppsListAccountsForPlanResponseDataItemMarketplacePurchase; organization_billing_email: string; type: string; url: string }

Type declaration

AppsListAccountsForPlanResponseDataItemMarketplacePendingChange

AppsListAccountsForPlanResponseDataItemMarketplacePendingChange: { effective_date: string; id: number; plan: AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan; unit_count: null }

Type declaration

AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan

AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsListAccountsForPlanResponseDataItemMarketplacePurchase

AppsListAccountsForPlanResponseDataItemMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan; unit_count: null; updated_at: string }

Type declaration

AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan

AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsListAccountsForPlanStubbedEndpoint

AppsListAccountsForPlanStubbedEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • plan_id: number

    plan_id parameter

  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsForPlanStubbedRequestOptions

AppsListAccountsForPlanStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/stubbed/plans/:plan_id/accounts" }

Type declaration

AppsListAccountsForPlanStubbedResponseData

AppsListAccountsForPlanStubbedResponseData: Array<AppsListAccountsForPlanStubbedResponseDataItem>

AppsListAccountsForPlanStubbedResponseDataItem

AppsListAccountsForPlanStubbedResponseDataItem: { email: null; id: number; login: string; marketplace_pending_change: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange; marketplace_purchase: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase; organization_billing_email: string; type: string; url: string }

Type declaration

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange: { effective_date: string; id: number; plan: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan; unit_count: null }

Type declaration

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan; unit_count: null; updated_at: string }

Type declaration

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsListInstallationReposForAuthenticatedUserEndpoint

AppsListInstallationReposForAuthenticatedUserEndpoint: { installation_id: number; page?: number; per_page?: number }

Type declaration

  • installation_id: number

    installation_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListInstallationReposForAuthenticatedUserRequestOptions

AppsListInstallationReposForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/installations/:installation_id/repositories" }

Type declaration

AppsListInstallationReposForAuthenticatedUserResponseData

AppsListInstallationReposForAuthenticatedUserResponseData: { repositories: Array<AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem>; total_count: number }

Type declaration

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner; permissions: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner
  • permissions: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

AppsListInstallationsEndpoint

AppsListInstallationsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListInstallationsForAuthenticatedUserEndpoint

AppsListInstallationsForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListInstallationsForAuthenticatedUserRequestOptions

AppsListInstallationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/installations" }

Type declaration

AppsListInstallationsForAuthenticatedUserResponseData

AppsListInstallationsForAuthenticatedUserResponseData: { installations: Array<AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem>; total_count: number }

Type declaration

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem: { access_tokens_url: string; account: AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount; app_id: number; events: Array<string>; html_url: string; id: number; permissions: AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions; repositories_url: string; single_file_name: string; target_id: number; target_type: string }

Type declaration

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount: { avatar_url: string; description?: string; events_url: string; followers_url?: string; following_url?: string; gists_url?: string; gravatar_id?: string; hooks_url?: string; html_url?: string; id: number; issues_url?: string; login: string; members_url?: string; node_id: string; organizations_url?: string; public_members_url?: string; received_events_url?: string; repos_url: string; site_admin?: boolean; starred_url?: string; subscriptions_url?: string; type?: string; url: string }

Type declaration

  • avatar_url: string
  • Optional description?: string
  • events_url: string
  • Optional followers_url?: string
  • Optional following_url?: string
  • Optional gists_url?: string
  • Optional gravatar_id?: string
  • Optional hooks_url?: string
  • Optional html_url?: string
  • id: number
  • Optional issues_url?: string
  • login: string
  • Optional members_url?: string
  • node_id: string
  • Optional organizations_url?: string
  • Optional public_members_url?: string
  • Optional received_events_url?: string
  • repos_url: string
  • Optional site_admin?: boolean
  • Optional starred_url?: string
  • Optional subscriptions_url?: string
  • Optional type?: string
  • url: string

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

AppsListInstallationsRequestOptions

AppsListInstallationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/app/installations" }

Type declaration

AppsListInstallationsResponseData

AppsListInstallationsResponseData: Array<AppsListInstallationsResponseDataItem>

AppsListInstallationsResponseDataItem

AppsListInstallationsResponseDataItem: { access_tokens_url: string; account: AppsListInstallationsResponseDataItemAccount; app_id: number; events: Array<string>; html_url: string; id: number; permissions: AppsListInstallationsResponseDataItemPermissions; repositories_url: string; repository_selection: string; single_file_name: string; target_id: number; target_type: string }

Type declaration

AppsListInstallationsResponseDataItemAccount

AppsListInstallationsResponseDataItemAccount: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

AppsListInstallationsResponseDataItemPermissions

AppsListInstallationsResponseDataItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

AppsListPlansEndpoint

AppsListPlansEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListPlansRequestOptions

AppsListPlansRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/plans" }

Type declaration

AppsListPlansResponseData

AppsListPlansResponseData: Array<AppsListPlansResponseDataItem>

AppsListPlansResponseDataItem

AppsListPlansResponseDataItem: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsListPlansStubbedEndpoint

AppsListPlansStubbedEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListPlansStubbedRequestOptions

AppsListPlansStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/stubbed/plans" }

Type declaration

AppsListPlansStubbedResponseData

AppsListPlansStubbedResponseData: Array<AppsListPlansStubbedResponseDataItem>

AppsListPlansStubbedResponseDataItem

AppsListPlansStubbedResponseDataItem: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsListReposEndpoint

AppsListReposEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListReposRequestOptions

AppsListReposRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/installation/repositories" }

Type declaration

AppsListReposResponseData

AppsListReposResponseData: { repositories: Array<AppsListReposResponseDataRepositoriesItem>; total_count: number }

Type declaration

AppsListReposResponseDataRepositoriesItem

AppsListReposResponseDataRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: AppsListReposResponseDataRepositoriesItemOwner; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: AppsListReposResponseDataRepositoriesItemOwner
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

AppsListReposResponseDataRepositoriesItemOwner

AppsListReposResponseDataRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsListSubscriptionsForAuthenticatedUserEndpoint

AppsListSubscriptionsForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserRequestOptions

AppsListSubscriptionsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/marketplace_purchases" }

Type declaration

AppsListSubscriptionsForAuthenticatedUserResponseData

AppsListSubscriptionsForAuthenticatedUserResponseData: Array<AppsListSubscriptionsForAuthenticatedUserResponseDataItem>

AppsListSubscriptionsForAuthenticatedUserResponseDataItem

AppsListSubscriptionsForAuthenticatedUserResponseDataItem: { account: AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount; billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan; unit_count: null; updated_at: string }

Type declaration

AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount

AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount: { email: null; id: number; login: string; organization_billing_email: string; type: string; url: string }

Type declaration

  • email: null
  • id: number
  • login: string
  • organization_billing_email: string
  • type: string
  • url: string

AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan

AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/marketplace_purchases/stubbed" }

Type declaration

AppsListSubscriptionsForAuthenticatedUserStubbedResponseData

AppsListSubscriptionsForAuthenticatedUserStubbedResponseData: Array<AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem>

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem: { account: AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount; billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan; unit_count: null; updated_at: string }

Type declaration

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount: { email: null; id: number; login: string; organization_billing_email: string; type: string; url: string }

Type declaration

  • email: null
  • id: number
  • login: string
  • organization_billing_email: string
  • type: string
  • url: string

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsRemoveRepoFromInstallationEndpoint

AppsRemoveRepoFromInstallationEndpoint: { installation_id: number; repository_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

  • repository_id: number

    repository_id parameter

AppsRemoveRepoFromInstallationRequestOptions

AppsRemoveRepoFromInstallationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/installations/:installation_id/repositories/:repository_id" }

Type declaration

AppsResetAuthorizationEndpoint

AppsResetAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsResetAuthorizationRequestOptions

AppsResetAuthorizationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/applications/:client_id/tokens/:access_token" }

Type declaration

AppsResetAuthorizationResponseData

AppsResetAuthorizationResponseData: { app: AppsResetAuthorizationResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsResetAuthorizationResponseDataUser }

Type declaration

AppsResetAuthorizationResponseDataApp

AppsResetAuthorizationResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

AppsResetAuthorizationResponseDataUser

AppsResetAuthorizationResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsResetTokenEndpoint

AppsResetTokenEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsResetTokenRequestOptions

AppsResetTokenRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/applications/:client_id/token" }

Type declaration

AppsResetTokenResponseData

AppsResetTokenResponseData: { app: AppsResetTokenResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsResetTokenResponseDataUser }

Type declaration

AppsResetTokenResponseDataApp

AppsResetTokenResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

AppsResetTokenResponseDataUser

AppsResetTokenResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsRevokeAuthorizationForApplicationEndpoint

AppsRevokeAuthorizationForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsRevokeAuthorizationForApplicationRequestOptions

AppsRevokeAuthorizationForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/tokens/:access_token" }

Type declaration

AppsRevokeGrantForApplicationEndpoint

AppsRevokeGrantForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsRevokeGrantForApplicationRequestOptions

AppsRevokeGrantForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/grants/:access_token" }

Type declaration

AppsRevokeInstallationTokenEndpoint

AppsRevokeInstallationTokenEndpoint: {}

Type declaration

AppsRevokeInstallationTokenRequestOptions

AppsRevokeInstallationTokenRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/installation/token" }

Type declaration

ChecksCreateEndpoint

ChecksCreateEndpoint: { actions?: ChecksCreateParamsActions[]; completed_at?: string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"; details_url?: string; external_id?: string; head_sha: string; name: string; output?: ChecksCreateParamsOutput; owner: string; repo: string; started_at?: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional actions?: ChecksCreateParamsActions[]

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions." To learn more about check runs and requested actions, see "Check runs and requested actions."

  • Optional completed_at?: string

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"

    Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url. Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.

  • Optional details_url?: string

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

  • Optional external_id?: string

    A reference for the run on the integrator's system.

  • head_sha: string

    The SHA of the commit.

  • name: string

    The name of the check. For example, "code-coverage".

  • Optional output?: ChecksCreateParamsOutput

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional started_at?: string

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional status?: "queued" | "in_progress" | "completed"

    The current status. Can be one of queued, in_progress, or completed.

ChecksCreateParamsActions

ChecksCreateParamsActions: { description: string; identifier: string; label: string }

Type declaration

  • description: string
  • identifier: string
  • label: string

ChecksCreateParamsOutput

ChecksCreateParamsOutput: { annotations?: ChecksCreateParamsOutputAnnotations[]; images?: ChecksCreateParamsOutputImages[]; summary: string; text?: string; title: string }

Type declaration

ChecksCreateParamsOutputAnnotations

ChecksCreateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: number; end_line: number; message: string; path: string; raw_details?: string; start_column?: number; start_line: number; title?: string }

Type declaration

  • annotation_level: "notice" | "warning" | "failure"
  • Optional end_column?: number
  • end_line: number
  • message: string
  • path: string
  • Optional raw_details?: string
  • Optional start_column?: number
  • start_line: number
  • Optional title?: string

ChecksCreateParamsOutputImages

ChecksCreateParamsOutputImages: { alt: string; caption?: string; image_url: string }

Type declaration

  • alt: string
  • Optional caption?: string
  • image_url: string

ChecksCreateRequestOptions

ChecksCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs" }

Type declaration

ChecksCreateResponseData

ChecksCreateResponseData: { app: ChecksCreateResponseDataApp; check_suite: ChecksCreateResponseDataCheckSuite; completed_at: null | string; conclusion: null | string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksCreateResponseDataOutput; pull_requests: Array<ChecksCreateResponseDataPullRequestsItem>; started_at: string; status: string; url: string }

Type declaration

ChecksCreateResponseDataApp

ChecksCreateResponseDataApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksCreateResponseDataAppOwner; permissions: ChecksCreateResponseDataAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksCreateResponseDataAppOwner

ChecksCreateResponseDataAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksCreateResponseDataAppPermissions

ChecksCreateResponseDataAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksCreateResponseDataCheckSuite

ChecksCreateResponseDataCheckSuite: { id: number }

Type declaration

  • id: number

ChecksCreateResponseDataOutput

ChecksCreateResponseDataOutput: { annotations_count?: number; annotations_url?: string; summary: string; text: string; title: string }

Type declaration

  • Optional annotations_count?: number
  • Optional annotations_url?: string
  • summary: string
  • text: string
  • title: string

ChecksCreateResponseDataPullRequestsItem

ChecksCreateResponseDataPullRequestsItem: { base: ChecksCreateResponseDataPullRequestsItemBase; head: ChecksCreateResponseDataPullRequestsItemHead; id: number; number: number; url: string }

Type declaration

ChecksCreateResponseDataPullRequestsItemBase

ChecksCreateResponseDataPullRequestsItemBase: { ref: string; repo: ChecksCreateResponseDataPullRequestsItemBaseRepo; sha: string }

Type declaration

ChecksCreateResponseDataPullRequestsItemBaseRepo

ChecksCreateResponseDataPullRequestsItemBaseRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksCreateResponseDataPullRequestsItemHead

ChecksCreateResponseDataPullRequestsItemHead: { ref: string; repo: ChecksCreateResponseDataPullRequestsItemHeadRepo; sha: string }

Type declaration

ChecksCreateResponseDataPullRequestsItemHeadRepo

ChecksCreateResponseDataPullRequestsItemHeadRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksCreateSuiteEndpoint

ChecksCreateSuiteEndpoint: { head_sha: string; owner: string; repo: string }

Type declaration

  • head_sha: string

    The sha of the head commit.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksCreateSuiteRequestOptions

ChecksCreateSuiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites" }

Type declaration

ChecksCreateSuiteResponseData

ChecksCreateSuiteResponseData: { after: string; app: ChecksCreateSuiteResponseDataApp; before: string; conclusion: string; head_branch: string; head_sha: string; id: number; node_id: string; pull_requests: Array<any>; repository: ChecksCreateSuiteResponseDataRepository; status: string; url: string }

Type declaration

ChecksCreateSuiteResponseDataApp

ChecksCreateSuiteResponseDataApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksCreateSuiteResponseDataAppOwner; permissions: ChecksCreateSuiteResponseDataAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksCreateSuiteResponseDataAppOwner

ChecksCreateSuiteResponseDataAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksCreateSuiteResponseDataAppPermissions

ChecksCreateSuiteResponseDataAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksCreateSuiteResponseDataRepository

ChecksCreateSuiteResponseDataRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksCreateSuiteResponseDataRepositoryOwner; permissions: ChecksCreateSuiteResponseDataRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ChecksCreateSuiteResponseDataRepositoryOwner
  • permissions: ChecksCreateSuiteResponseDataRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ChecksCreateSuiteResponseDataRepositoryOwner

ChecksCreateSuiteResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ChecksCreateSuiteResponseDataRepositoryPermissions

ChecksCreateSuiteResponseDataRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ChecksGetEndpoint

ChecksGetEndpoint: { check_run_id: number; owner: string; repo: string }

Type declaration

  • check_run_id: number

    check_run_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksGetRequestOptions

ChecksGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs/:check_run_id" }

Type declaration

ChecksGetResponseData

ChecksGetResponseData: { app: ChecksGetResponseDataApp; check_suite: ChecksGetResponseDataCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksGetResponseDataOutput; pull_requests: Array<ChecksGetResponseDataPullRequestsItem>; started_at: string; status: string; url: string }

Type declaration

ChecksGetResponseDataApp

ChecksGetResponseDataApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksGetResponseDataAppOwner; permissions: ChecksGetResponseDataAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksGetResponseDataAppOwner

ChecksGetResponseDataAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksGetResponseDataAppPermissions

ChecksGetResponseDataAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksGetResponseDataCheckSuite

ChecksGetResponseDataCheckSuite: { id: number }

Type declaration

  • id: number

ChecksGetResponseDataOutput

ChecksGetResponseDataOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

Type declaration

  • annotations_count: number
  • annotations_url: string
  • summary: string
  • text: string
  • title: string

ChecksGetResponseDataPullRequestsItem

ChecksGetResponseDataPullRequestsItem: { base: ChecksGetResponseDataPullRequestsItemBase; head: ChecksGetResponseDataPullRequestsItemHead; id: number; number: number; url: string }

Type declaration

ChecksGetResponseDataPullRequestsItemBase

ChecksGetResponseDataPullRequestsItemBase: { ref: string; repo: ChecksGetResponseDataPullRequestsItemBaseRepo; sha: string }

Type declaration

ChecksGetResponseDataPullRequestsItemBaseRepo

ChecksGetResponseDataPullRequestsItemBaseRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksGetResponseDataPullRequestsItemHead

ChecksGetResponseDataPullRequestsItemHead: { ref: string; repo: ChecksGetResponseDataPullRequestsItemHeadRepo; sha: string }

Type declaration

ChecksGetResponseDataPullRequestsItemHeadRepo

ChecksGetResponseDataPullRequestsItemHeadRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksGetSuiteEndpoint

ChecksGetSuiteEndpoint: { check_suite_id: number; owner: string; repo: string }

Type declaration

  • check_suite_id: number

    check_suite_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksGetSuiteRequestOptions

ChecksGetSuiteRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/:check_suite_id" }

Type declaration

ChecksGetSuiteResponseData

ChecksGetSuiteResponseData: { after: string; app: ChecksGetSuiteResponseDataApp; before: string; conclusion: string; head_branch: string; head_sha: string; id: number; node_id: string; pull_requests: Array<any>; repository: ChecksGetSuiteResponseDataRepository; status: string; url: string }

Type declaration

ChecksGetSuiteResponseDataApp

ChecksGetSuiteResponseDataApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksGetSuiteResponseDataAppOwner; permissions: ChecksGetSuiteResponseDataAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksGetSuiteResponseDataAppOwner

ChecksGetSuiteResponseDataAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksGetSuiteResponseDataAppPermissions

ChecksGetSuiteResponseDataAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksGetSuiteResponseDataRepository

ChecksGetSuiteResponseDataRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksGetSuiteResponseDataRepositoryOwner; permissions: ChecksGetSuiteResponseDataRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ChecksGetSuiteResponseDataRepositoryOwner
  • permissions: ChecksGetSuiteResponseDataRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ChecksGetSuiteResponseDataRepositoryOwner

ChecksGetSuiteResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ChecksGetSuiteResponseDataRepositoryPermissions

ChecksGetSuiteResponseDataRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ChecksListAnnotationsEndpoint

ChecksListAnnotationsEndpoint: { check_run_id: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • check_run_id: number

    check_run_id parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ChecksListAnnotationsRequestOptions

ChecksListAnnotationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations" }

Type declaration

ChecksListAnnotationsResponseData

ChecksListAnnotationsResponseData: Array<ChecksListAnnotationsResponseDataItem>

ChecksListAnnotationsResponseDataItem

ChecksListAnnotationsResponseDataItem: { annotation_level: string; end_column: number; end_line: number; message: string; path: string; raw_details: string; start_column: number; start_line: number; title: string }

Type declaration

  • annotation_level: string
  • end_column: number
  • end_line: number
  • message: string
  • path: string
  • raw_details: string
  • start_column: number
  • start_line: number
  • title: string

ChecksListForRefEndpoint

ChecksListForRefEndpoint: { check_name?: string; filter?: "latest" | "all"; owner: string; page?: number; per_page?: number; ref: string; repo: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional check_name?: string

    Returns check runs with the specified name.

  • Optional filter?: "latest" | "all"

    Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

  • Optional status?: "queued" | "in_progress" | "completed"

    Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

ChecksListForRefRequestOptions

ChecksListForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/check-runs" }

Type declaration

ChecksListForRefResponseData

ChecksListForRefResponseData: { check_runs: Array<ChecksListForRefResponseDataCheckRunsItem>; total_count: number }

Type declaration

ChecksListForRefResponseDataCheckRunsItem

ChecksListForRefResponseDataCheckRunsItem: { app: ChecksListForRefResponseDataCheckRunsItemApp; check_suite: ChecksListForRefResponseDataCheckRunsItemCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksListForRefResponseDataCheckRunsItemOutput; pull_requests: Array<ChecksListForRefResponseDataCheckRunsItemPullRequestsItem>; started_at: string; status: string; url: string }

Type declaration

ChecksListForRefResponseDataCheckRunsItemApp

ChecksListForRefResponseDataCheckRunsItemApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksListForRefResponseDataCheckRunsItemAppOwner; permissions: ChecksListForRefResponseDataCheckRunsItemAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksListForRefResponseDataCheckRunsItemAppOwner

ChecksListForRefResponseDataCheckRunsItemAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksListForRefResponseDataCheckRunsItemAppPermissions

ChecksListForRefResponseDataCheckRunsItemAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksListForRefResponseDataCheckRunsItemCheckSuite

ChecksListForRefResponseDataCheckRunsItemCheckSuite: { id: number }

Type declaration

  • id: number

ChecksListForRefResponseDataCheckRunsItemOutput

ChecksListForRefResponseDataCheckRunsItemOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

Type declaration

  • annotations_count: number
  • annotations_url: string
  • summary: string
  • text: string
  • title: string

ChecksListForRefResponseDataCheckRunsItemPullRequestsItem

ChecksListForRefResponseDataCheckRunsItemPullRequestsItem: { base: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase; head: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead; id: number; number: number; url: string }

Type declaration

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase: { ref: string; repo: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo; sha: string }

Type declaration

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead: { ref: string; repo: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo; sha: string }

Type declaration

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksListForSuiteEndpoint

ChecksListForSuiteEndpoint: { check_name?: string; check_suite_id: number; filter?: "latest" | "all"; owner: string; page?: number; per_page?: number; repo: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional check_name?: string

    Returns check runs with the specified name.

  • check_suite_id: number

    check_suite_id parameter

  • Optional filter?: "latest" | "all"

    Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional status?: "queued" | "in_progress" | "completed"

    Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

ChecksListForSuiteRequestOptions

ChecksListForSuiteRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs" }

Type declaration

ChecksListForSuiteResponseData

ChecksListForSuiteResponseData: { check_runs: Array<ChecksListForSuiteResponseDataCheckRunsItem>; total_count: number }

Type declaration

ChecksListForSuiteResponseDataCheckRunsItem

ChecksListForSuiteResponseDataCheckRunsItem: { app: ChecksListForSuiteResponseDataCheckRunsItemApp; check_suite: ChecksListForSuiteResponseDataCheckRunsItemCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksListForSuiteResponseDataCheckRunsItemOutput; pull_requests: Array<ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem>; started_at: string; status: string; url: string }

Type declaration

ChecksListForSuiteResponseDataCheckRunsItemApp

ChecksListForSuiteResponseDataCheckRunsItemApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksListForSuiteResponseDataCheckRunsItemAppOwner; permissions: ChecksListForSuiteResponseDataCheckRunsItemAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksListForSuiteResponseDataCheckRunsItemAppOwner

ChecksListForSuiteResponseDataCheckRunsItemAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksListForSuiteResponseDataCheckRunsItemAppPermissions

ChecksListForSuiteResponseDataCheckRunsItemAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksListForSuiteResponseDataCheckRunsItemCheckSuite

ChecksListForSuiteResponseDataCheckRunsItemCheckSuite: { id: number }

Type declaration

  • id: number

ChecksListForSuiteResponseDataCheckRunsItemOutput

ChecksListForSuiteResponseDataCheckRunsItemOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

Type declaration

  • annotations_count: number
  • annotations_url: string
  • summary: string
  • text: string
  • title: string

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem: { base: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase; head: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead; id: number; number: number; url: string }

Type declaration

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase: { ref: string; repo: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo; sha: string }

Type declaration

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead: { ref: string; repo: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo; sha: string }

Type declaration

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksListSuitesForRefEndpoint

ChecksListSuitesForRefEndpoint: { app_id?: number; check_name?: string; owner: string; page?: number; per_page?: number; ref: string; repo: string }

Type declaration

  • Optional app_id?: number

    Filters check suites by GitHub App id.

  • Optional check_name?: string

    Filters checks suites by the name of the check run.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ChecksListSuitesForRefRequestOptions

ChecksListSuitesForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/check-suites" }

Type declaration

ChecksListSuitesForRefResponseData

ChecksListSuitesForRefResponseData: { check_suites: Array<ChecksListSuitesForRefResponseDataCheckSuitesItem>; total_count: number }

Type declaration

ChecksListSuitesForRefResponseDataCheckSuitesItem

ChecksListSuitesForRefResponseDataCheckSuitesItem: { after: string; app: ChecksListSuitesForRefResponseDataCheckSuitesItemApp; before: string; conclusion: string; head_branch: string; head_sha: string; id: number; node_id: string; pull_requests: Array<any>; repository: ChecksListSuitesForRefResponseDataCheckSuitesItemRepository; status: string; url: string }

Type declaration

ChecksListSuitesForRefResponseDataCheckSuitesItemApp

ChecksListSuitesForRefResponseDataCheckSuitesItemApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner; permissions: ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner

ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions

ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksListSuitesForRefResponseDataCheckSuitesItemRepository

ChecksListSuitesForRefResponseDataCheckSuitesItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner; permissions: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner
  • permissions: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ChecksRerequestSuiteEndpoint

ChecksRerequestSuiteEndpoint: { check_suite_id: number; owner: string; repo: string }

Type declaration

  • check_suite_id: number

    check_suite_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksRerequestSuiteRequestOptions

ChecksRerequestSuiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest" }

Type declaration

ChecksSetSuitesPreferencesEndpoint

ChecksSetSuitesPreferencesEndpoint: { auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; owner: string; repo: string }

Type declaration

ChecksSetSuitesPreferencesParamsAutoTriggerChecks

ChecksSetSuitesPreferencesParamsAutoTriggerChecks: { app_id: number; setting: boolean }

Type declaration

  • app_id: number
  • setting: boolean

ChecksSetSuitesPreferencesRequestOptions

ChecksSetSuitesPreferencesRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/preferences" }

Type declaration

ChecksSetSuitesPreferencesResponseData

ChecksSetSuitesPreferencesResponseData: { preferences: ChecksSetSuitesPreferencesResponseDataPreferences; repository: ChecksSetSuitesPreferencesResponseDataRepository }

Type declaration

ChecksSetSuitesPreferencesResponseDataPreferences

ChecksSetSuitesPreferencesResponseDataPreferences: { auto_trigger_checks: Array<ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem> }

Type declaration

ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem

ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem: { app_id: number; setting: boolean }

Type declaration

  • app_id: number
  • setting: boolean

ChecksSetSuitesPreferencesResponseDataRepository

ChecksSetSuitesPreferencesResponseDataRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksSetSuitesPreferencesResponseDataRepositoryOwner; permissions: ChecksSetSuitesPreferencesResponseDataRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ChecksSetSuitesPreferencesResponseDataRepositoryOwner
  • permissions: ChecksSetSuitesPreferencesResponseDataRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ChecksSetSuitesPreferencesResponseDataRepositoryOwner

ChecksSetSuitesPreferencesResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ChecksSetSuitesPreferencesResponseDataRepositoryPermissions

ChecksSetSuitesPreferencesResponseDataRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ChecksUpdateEndpoint

ChecksUpdateEndpoint: { actions?: ChecksUpdateParamsActions[]; check_run_id: number; completed_at?: string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"; details_url?: string; external_id?: string; name?: string; output?: ChecksUpdateParamsOutput; owner: string; repo: string; started_at?: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional actions?: ChecksUpdateParamsActions[]

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions."

  • check_run_id: number

    check_run_id parameter

  • Optional completed_at?: string

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"

    Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.

  • Optional details_url?: string

    The URL of the integrator's site that has the full details of the check.

  • Optional external_id?: string

    A reference for the run on the integrator's system.

  • Optional name?: string

    The name of the check. For example, "code-coverage".

  • Optional output?: ChecksUpdateParamsOutput

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional started_at?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional status?: "queued" | "in_progress" | "completed"

    The current status. Can be one of queued, in_progress, or completed.

ChecksUpdateParamsActions

ChecksUpdateParamsActions: { description: string; identifier: string; label: string }

Type declaration

  • description: string
  • identifier: string
  • label: string

ChecksUpdateParamsOutput

ChecksUpdateParamsOutput: { annotations?: ChecksUpdateParamsOutputAnnotations[]; images?: ChecksUpdateParamsOutputImages[]; summary: string; text?: string; title?: string }

Type declaration

ChecksUpdateParamsOutputAnnotations

ChecksUpdateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: number; end_line: number; message: string; path: string; raw_details?: string; start_column?: number; start_line: number; title?: string }

Type declaration

  • annotation_level: "notice" | "warning" | "failure"
  • Optional end_column?: number
  • end_line: number
  • message: string
  • path: string
  • Optional raw_details?: string
  • Optional start_column?: number
  • start_line: number
  • Optional title?: string

ChecksUpdateParamsOutputImages

ChecksUpdateParamsOutputImages: { alt: string; caption?: string; image_url: string }

Type declaration

  • alt: string
  • Optional caption?: string
  • image_url: string

ChecksUpdateRequestOptions

ChecksUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs/:check_run_id" }

Type declaration

ChecksUpdateResponseData

ChecksUpdateResponseData: { app: ChecksUpdateResponseDataApp; check_suite: ChecksUpdateResponseDataCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksUpdateResponseDataOutput; pull_requests: Array<ChecksUpdateResponseDataPullRequestsItem>; started_at: string; status: string; url: string }

Type declaration

ChecksUpdateResponseDataApp

ChecksUpdateResponseDataApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksUpdateResponseDataAppOwner; permissions: ChecksUpdateResponseDataAppPermissions; slug: string; updated_at: string }

Type declaration

ChecksUpdateResponseDataAppOwner

ChecksUpdateResponseDataAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ChecksUpdateResponseDataAppPermissions

ChecksUpdateResponseDataAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ChecksUpdateResponseDataCheckSuite

ChecksUpdateResponseDataCheckSuite: { id: number }

Type declaration

  • id: number

ChecksUpdateResponseDataOutput

ChecksUpdateResponseDataOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

Type declaration

  • annotations_count: number
  • annotations_url: string
  • summary: string
  • text: string
  • title: string

ChecksUpdateResponseDataPullRequestsItem

ChecksUpdateResponseDataPullRequestsItem: { base: ChecksUpdateResponseDataPullRequestsItemBase; head: ChecksUpdateResponseDataPullRequestsItemHead; id: number; number: number; url: string }

Type declaration

ChecksUpdateResponseDataPullRequestsItemBase

ChecksUpdateResponseDataPullRequestsItemBase: { ref: string; repo: ChecksUpdateResponseDataPullRequestsItemBaseRepo; sha: string }

Type declaration

ChecksUpdateResponseDataPullRequestsItemBaseRepo

ChecksUpdateResponseDataPullRequestsItemBaseRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

ChecksUpdateResponseDataPullRequestsItemHead

ChecksUpdateResponseDataPullRequestsItemHead: { ref: string; repo: ChecksUpdateResponseDataPullRequestsItemHeadRepo; sha: string }

Type declaration

ChecksUpdateResponseDataPullRequestsItemHeadRepo

ChecksUpdateResponseDataPullRequestsItemHeadRepo: { id: number; name: string; url: string }

Type declaration

  • id: number
  • name: string
  • url: string

CodesOfConductGetAllCodesOfConductEndpoint

CodesOfConductGetAllCodesOfConductEndpoint: {}

Type declaration

CodesOfConductGetAllCodesOfConductRequestOptions

CodesOfConductGetAllCodesOfConductRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/codes_of_conduct" }

Type declaration

CodesOfConductGetAllCodesOfConductResponseData

CodesOfConductGetAllCodesOfConductResponseData: Array<CodesOfConductGetAllCodesOfConductResponseDataItem>

CodesOfConductGetAllCodesOfConductResponseDataItem

CodesOfConductGetAllCodesOfConductResponseDataItem: { key: string; name: string; url: string }

Type declaration

  • key: string
  • name: string
  • url: string

CodesOfConductGetConductCodeEndpoint

CodesOfConductGetConductCodeEndpoint: { key: string }

Type declaration

  • key: string

    key parameter

CodesOfConductGetConductCodeRequestOptions

CodesOfConductGetConductCodeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/codes_of_conduct/:key" }

Type declaration

CodesOfConductGetConductCodeResponseData

CodesOfConductGetConductCodeResponseData: { body: string; key: string; name: string; url: string }

Type declaration

  • body: string
  • key: string
  • name: string
  • url: string

CodesOfConductGetForRepoEndpoint

CodesOfConductGetForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

CodesOfConductGetForRepoRequestOptions

CodesOfConductGetForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/community/code_of_conduct" }

Type declaration

CodesOfConductGetForRepoResponseData

CodesOfConductGetForRepoResponseData: { body: string; key: string; name: string; url: string }

Type declaration

  • body: string
  • key: string
  • name: string
  • url: string

EmojisGetEndpoint

EmojisGetEndpoint: {}

Type declaration

EmojisGetRequestOptions

EmojisGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/emojis" }

Type declaration

GistsCheckIsStarredEndpoint

GistsCheckIsStarredEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsCheckIsStarredRequestOptions

GistsCheckIsStarredRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/star" }

Type declaration

GistsCreateCommentEndpoint

GistsCreateCommentEndpoint: { body: string; gist_id: string }

Type declaration

  • body: string

    The comment text.

  • gist_id: string

    gist_id parameter

GistsCreateCommentRequestOptions

GistsCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/gists/:gist_id/comments" }

Type declaration

GistsCreateCommentResponseData

GistsCreateCommentResponseData: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsCreateCommentResponseDataUser }

Type declaration

GistsCreateCommentResponseDataUser

GistsCreateCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsCreateEndpoint

GistsCreateEndpoint: { description?: string; files: GistsCreateParamsFiles; public?: boolean }

Type declaration

  • Optional description?: string

    A descriptive name for this gist.

  • files: GistsCreateParamsFiles

    The filenames and content of each file in the gist. The keys in the files object represent the filename and have the type string.

  • Optional public?: boolean

    When true, the gist will be public and available for anyone to see.

GistsCreateParamsFiles

GistsCreateParamsFiles: { content?: string }

Type declaration

  • Optional content?: string

GistsCreateRequestOptions

GistsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/gists" }

Type declaration

GistsCreateResponseData

GistsCreateResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsCreateResponseDataFiles; forks: Array<GistsCreateResponseDataForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsCreateResponseDataHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsCreateResponseDataOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

GistsCreateResponseDataFiles

GistsCreateResponseDataFiles: { hello_world.py: GistsCreateResponseDataFilesHelloWorldPy; hello_world.rb: GistsCreateResponseDataFilesHelloWorldRb; hello_world_python.txt: GistsCreateResponseDataFilesHelloWorldPythonTxt; hello_world_ruby.txt: GistsCreateResponseDataFilesHelloWorldRubyTxt }

Type declaration

GistsCreateResponseDataFilesHelloWorldPy

GistsCreateResponseDataFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsCreateResponseDataFilesHelloWorldPythonTxt

GistsCreateResponseDataFilesHelloWorldPythonTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsCreateResponseDataFilesHelloWorldRb

GistsCreateResponseDataFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsCreateResponseDataFilesHelloWorldRubyTxt

GistsCreateResponseDataFilesHelloWorldRubyTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsCreateResponseDataForksItem

GistsCreateResponseDataForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsCreateResponseDataForksItemUser }

Type declaration

GistsCreateResponseDataForksItemUser

GistsCreateResponseDataForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsCreateResponseDataHistoryItem

GistsCreateResponseDataHistoryItem: { change_status: GistsCreateResponseDataHistoryItemChangeStatus; committed_at: string; url: string; user: GistsCreateResponseDataHistoryItemUser; version: string }

Type declaration

GistsCreateResponseDataHistoryItemChangeStatus

GistsCreateResponseDataHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

Type declaration

  • additions: number
  • deletions: number
  • total: number

GistsCreateResponseDataHistoryItemUser

GistsCreateResponseDataHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsCreateResponseDataOwner

GistsCreateResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsDeleteCommentEndpoint

GistsDeleteCommentEndpoint: { comment_id: number; gist_id: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • gist_id: string

    gist_id parameter

GistsDeleteCommentRequestOptions

GistsDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/gists/:gist_id/comments/:comment_id" }

Type declaration

GistsDeleteEndpoint

GistsDeleteEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsDeleteRequestOptions

GistsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/gists/:gist_id" }

Type declaration

GistsForkEndpoint

GistsForkEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsForkRequestOptions

GistsForkRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/gists/:gist_id/forks" }

Type declaration

GistsForkResponseData

GistsForkResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsForkResponseDataFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsForkResponseDataOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

  • comments: number
  • comments_url: string
  • commits_url: string
  • created_at: string
  • description: string
  • files: GistsForkResponseDataFiles
  • forks_url: string
  • git_pull_url: string
  • git_push_url: string
  • html_url: string
  • id: string
  • node_id: string
  • owner: GistsForkResponseDataOwner
  • public: boolean
  • truncated: boolean
  • updated_at: string
  • url: string
  • user: null

GistsForkResponseDataFiles

GistsForkResponseDataFiles: { hello_world.rb: GistsForkResponseDataFilesHelloWorldRb }

Type declaration

GistsForkResponseDataFilesHelloWorldRb

GistsForkResponseDataFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

Type declaration

  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • type: string

GistsForkResponseDataOwner

GistsForkResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsGetCommentEndpoint

GistsGetCommentEndpoint: { comment_id: number; gist_id: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • gist_id: string

    gist_id parameter

GistsGetCommentRequestOptions

GistsGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/comments/:comment_id" }

Type declaration

GistsGetCommentResponseData

GistsGetCommentResponseData: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsGetCommentResponseDataUser }

Type declaration

GistsGetCommentResponseDataUser

GistsGetCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsGetEndpoint

GistsGetEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsGetRequestOptions

GistsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id" }

Type declaration

GistsGetResponseData

GistsGetResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsGetResponseDataFiles; forks: Array<GistsGetResponseDataForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsGetResponseDataHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsGetResponseDataOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

GistsGetResponseDataFiles

GistsGetResponseDataFiles: { hello_world.py: GistsGetResponseDataFilesHelloWorldPy; hello_world.rb: GistsGetResponseDataFilesHelloWorldRb; hello_world_python.txt: GistsGetResponseDataFilesHelloWorldPythonTxt; hello_world_ruby.txt: GistsGetResponseDataFilesHelloWorldRubyTxt }

Type declaration

GistsGetResponseDataFilesHelloWorldPy

GistsGetResponseDataFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetResponseDataFilesHelloWorldPythonTxt

GistsGetResponseDataFilesHelloWorldPythonTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetResponseDataFilesHelloWorldRb

GistsGetResponseDataFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetResponseDataFilesHelloWorldRubyTxt

GistsGetResponseDataFilesHelloWorldRubyTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetResponseDataForksItem

GistsGetResponseDataForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsGetResponseDataForksItemUser }

Type declaration

GistsGetResponseDataForksItemUser

GistsGetResponseDataForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsGetResponseDataHistoryItem

GistsGetResponseDataHistoryItem: { change_status: GistsGetResponseDataHistoryItemChangeStatus; committed_at: string; url: string; user: GistsGetResponseDataHistoryItemUser; version: string }

Type declaration

GistsGetResponseDataHistoryItemChangeStatus

GistsGetResponseDataHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

Type declaration

  • additions: number
  • deletions: number
  • total: number

GistsGetResponseDataHistoryItemUser

GistsGetResponseDataHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsGetResponseDataOwner

GistsGetResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsGetRevisionEndpoint

GistsGetRevisionEndpoint: { gist_id: string; sha: string }

Type declaration

  • gist_id: string

    gist_id parameter

  • sha: string

    sha parameter

GistsGetRevisionRequestOptions

GistsGetRevisionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/:sha" }

Type declaration

GistsGetRevisionResponseData

GistsGetRevisionResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsGetRevisionResponseDataFiles; forks: Array<GistsGetRevisionResponseDataForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsGetRevisionResponseDataHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsGetRevisionResponseDataOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

GistsGetRevisionResponseDataFiles

GistsGetRevisionResponseDataFiles: { hello_world.py: GistsGetRevisionResponseDataFilesHelloWorldPy; hello_world.rb: GistsGetRevisionResponseDataFilesHelloWorldRb; hello_world_python.txt: GistsGetRevisionResponseDataFilesHelloWorldPythonTxt; hello_world_ruby.txt: GistsGetRevisionResponseDataFilesHelloWorldRubyTxt }

Type declaration

GistsGetRevisionResponseDataFilesHelloWorldPy

GistsGetRevisionResponseDataFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetRevisionResponseDataFilesHelloWorldPythonTxt

GistsGetRevisionResponseDataFilesHelloWorldPythonTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetRevisionResponseDataFilesHelloWorldRb

GistsGetRevisionResponseDataFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetRevisionResponseDataFilesHelloWorldRubyTxt

GistsGetRevisionResponseDataFilesHelloWorldRubyTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsGetRevisionResponseDataForksItem

GistsGetRevisionResponseDataForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsGetRevisionResponseDataForksItemUser }

Type declaration

GistsGetRevisionResponseDataForksItemUser

GistsGetRevisionResponseDataForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsGetRevisionResponseDataHistoryItem

GistsGetRevisionResponseDataHistoryItem: { change_status: GistsGetRevisionResponseDataHistoryItemChangeStatus; committed_at: string; url: string; user: GistsGetRevisionResponseDataHistoryItemUser; version: string }

Type declaration

GistsGetRevisionResponseDataHistoryItemChangeStatus

GistsGetRevisionResponseDataHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

Type declaration

  • additions: number
  • deletions: number
  • total: number

GistsGetRevisionResponseDataHistoryItemUser

GistsGetRevisionResponseDataHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsGetRevisionResponseDataOwner

GistsGetRevisionResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsListCommentsEndpoint

GistsListCommentsEndpoint: { gist_id: string; page?: number; per_page?: number }

Type declaration

  • gist_id: string

    gist_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

GistsListCommentsRequestOptions

GistsListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/comments" }

Type declaration

GistsListCommentsResponseData

GistsListCommentsResponseData: Array<GistsListCommentsResponseDataItem>

GistsListCommentsResponseDataItem

GistsListCommentsResponseDataItem: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsListCommentsResponseDataItemUser }

Type declaration

GistsListCommentsResponseDataItemUser

GistsListCommentsResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsListCommitsEndpoint

GistsListCommitsEndpoint: { gist_id: string; page?: number; per_page?: number }

Type declaration

  • gist_id: string

    gist_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

GistsListCommitsRequestOptions

GistsListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/commits" }

Type declaration

GistsListCommitsResponseData

GistsListCommitsResponseData: Array<GistsListCommitsResponseDataItem>

GistsListCommitsResponseDataItem

GistsListCommitsResponseDataItem: { change_status: GistsListCommitsResponseDataItemChangeStatus; committed_at: string; url: string; user: GistsListCommitsResponseDataItemUser; version: string }

Type declaration

GistsListCommitsResponseDataItemChangeStatus

GistsListCommitsResponseDataItemChangeStatus: { additions: number; deletions: number; total: number }

Type declaration

  • additions: number
  • deletions: number
  • total: number

GistsListCommitsResponseDataItemUser

GistsListCommitsResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsListEndpoint

GistsListEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListForUserEndpoint

GistsListForUserEndpoint: { page?: number; per_page?: number; since?: string; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

  • username: string

    username parameter

GistsListForUserRequestOptions

GistsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/gists" }

Type declaration

GistsListForUserResponseData

GistsListForUserResponseData: Array<GistsListForUserResponseDataItem>

GistsListForUserResponseDataItem

GistsListForUserResponseDataItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListForUserResponseDataItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListForUserResponseDataItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

GistsListForUserResponseDataItemFiles

GistsListForUserResponseDataItemFiles: { hello_world.rb: GistsListForUserResponseDataItemFilesHelloWorldRb }

Type declaration

GistsListForUserResponseDataItemFilesHelloWorldRb

GistsListForUserResponseDataItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

Type declaration

  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • type: string

GistsListForUserResponseDataItemOwner

GistsListForUserResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsListForksEndpoint

GistsListForksEndpoint: { gist_id: string; page?: number; per_page?: number }

Type declaration

  • gist_id: string

    gist_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

GistsListForksRequestOptions

GistsListForksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/forks" }

Type declaration

GistsListForksResponseData

GistsListForksResponseData: Array<GistsListForksResponseDataItem>

GistsListForksResponseDataItem

GistsListForksResponseDataItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsListForksResponseDataItemUser }

Type declaration

GistsListForksResponseDataItemUser

GistsListForksResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsListPublicEndpoint

GistsListPublicEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListPublicRequestOptions

GistsListPublicRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/public" }

Type declaration

GistsListPublicResponseData

GistsListPublicResponseData: Array<GistsListPublicResponseDataItem>

GistsListPublicResponseDataItem

GistsListPublicResponseDataItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListPublicResponseDataItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListPublicResponseDataItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

  • comments: number
  • comments_url: string
  • commits_url: string
  • created_at: string
  • description: string
  • files: GistsListPublicResponseDataItemFiles
  • forks_url: string
  • git_pull_url: string
  • git_push_url: string
  • html_url: string
  • id: string
  • node_id: string
  • owner: GistsListPublicResponseDataItemOwner
  • public: boolean
  • truncated: boolean
  • updated_at: string
  • url: string
  • user: null

GistsListPublicResponseDataItemFiles

GistsListPublicResponseDataItemFiles: { hello_world.rb: GistsListPublicResponseDataItemFilesHelloWorldRb }

Type declaration

GistsListPublicResponseDataItemFilesHelloWorldRb

GistsListPublicResponseDataItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

Type declaration

  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • type: string

GistsListPublicResponseDataItemOwner

GistsListPublicResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsListRequestOptions

GistsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists" }

Type declaration

GistsListResponseData

GistsListResponseData: Array<GistsListResponseDataItem>

GistsListResponseDataItem

GistsListResponseDataItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListResponseDataItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListResponseDataItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

  • comments: number
  • comments_url: string
  • commits_url: string
  • created_at: string
  • description: string
  • files: GistsListResponseDataItemFiles
  • forks_url: string
  • git_pull_url: string
  • git_push_url: string
  • html_url: string
  • id: string
  • node_id: string
  • owner: GistsListResponseDataItemOwner
  • public: boolean
  • truncated: boolean
  • updated_at: string
  • url: string
  • user: null

GistsListResponseDataItemFiles

GistsListResponseDataItemFiles: { hello_world.rb: GistsListResponseDataItemFilesHelloWorldRb }

Type declaration

GistsListResponseDataItemFilesHelloWorldRb

GistsListResponseDataItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

Type declaration

  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • type: string

GistsListResponseDataItemOwner

GistsListResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsListStarredEndpoint

GistsListStarredEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListStarredRequestOptions

GistsListStarredRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/starred" }

Type declaration

GistsListStarredResponseData

GistsListStarredResponseData: Array<GistsListStarredResponseDataItem>

GistsListStarredResponseDataItem

GistsListStarredResponseDataItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListStarredResponseDataItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListStarredResponseDataItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

GistsListStarredResponseDataItemFiles

GistsListStarredResponseDataItemFiles: { hello_world.rb: GistsListStarredResponseDataItemFilesHelloWorldRb }

Type declaration

GistsListStarredResponseDataItemFilesHelloWorldRb

GistsListStarredResponseDataItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

Type declaration

  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • type: string

GistsListStarredResponseDataItemOwner

GistsListStarredResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsStarEndpoint

GistsStarEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsStarRequestOptions

GistsStarRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/gists/:gist_id/star" }

Type declaration

GistsUnstarEndpoint

GistsUnstarEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsUnstarRequestOptions

GistsUnstarRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/gists/:gist_id/star" }

Type declaration

GistsUpdateCommentEndpoint

GistsUpdateCommentEndpoint: { body: string; comment_id: number; gist_id: string }

Type declaration

  • body: string

    The comment text.

  • comment_id: number

    comment_id parameter

  • gist_id: string

    gist_id parameter

GistsUpdateCommentRequestOptions

GistsUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/gists/:gist_id/comments/:comment_id" }

Type declaration

GistsUpdateCommentResponseData

GistsUpdateCommentResponseData: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsUpdateCommentResponseDataUser }

Type declaration

GistsUpdateCommentResponseDataUser

GistsUpdateCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsUpdateEndpoint

GistsUpdateEndpoint: { description?: string; files?: GistsUpdateParamsFiles; gist_id: string }

Type declaration

  • Optional description?: string

    A descriptive name for this gist.

  • Optional files?: GistsUpdateParamsFiles

    The filenames and content that make up this gist.

  • gist_id: string

    gist_id parameter

GistsUpdateParamsFiles

GistsUpdateParamsFiles: { content?: string; filename?: string }

Type declaration

  • Optional content?: string
  • Optional filename?: string

GistsUpdateRequestOptions

GistsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/gists/:gist_id" }

Type declaration

GistsUpdateResponseData

GistsUpdateResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsUpdateResponseDataFiles; forks: Array<GistsUpdateResponseDataForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsUpdateResponseDataHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsUpdateResponseDataOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

Type declaration

GistsUpdateResponseDataFiles

GistsUpdateResponseDataFiles: { hello_world.md: GistsUpdateResponseDataFilesHelloWorldMd; hello_world.py: GistsUpdateResponseDataFilesHelloWorldPy; hello_world.rb: GistsUpdateResponseDataFilesHelloWorldRb; new_file.txt: GistsUpdateResponseDataFilesNewFileTxt }

Type declaration

GistsUpdateResponseDataFilesHelloWorldMd

GistsUpdateResponseDataFilesHelloWorldMd: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsUpdateResponseDataFilesHelloWorldPy

GistsUpdateResponseDataFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsUpdateResponseDataFilesHelloWorldRb

GistsUpdateResponseDataFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsUpdateResponseDataFilesNewFileTxt

GistsUpdateResponseDataFilesNewFileTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

Type declaration

  • content: string
  • filename: string
  • language: string
  • raw_url: string
  • size: number
  • truncated: boolean
  • type: string

GistsUpdateResponseDataForksItem

GistsUpdateResponseDataForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsUpdateResponseDataForksItemUser }

Type declaration

GistsUpdateResponseDataForksItemUser

GistsUpdateResponseDataForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsUpdateResponseDataHistoryItem

GistsUpdateResponseDataHistoryItem: { change_status: GistsUpdateResponseDataHistoryItemChangeStatus; committed_at: string; url: string; user: GistsUpdateResponseDataHistoryItemUser; version: string }

Type declaration

GistsUpdateResponseDataHistoryItemChangeStatus

GistsUpdateResponseDataHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

Type declaration

  • additions: number
  • deletions: number
  • total: number

GistsUpdateResponseDataHistoryItemUser

GistsUpdateResponseDataHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GistsUpdateResponseDataOwner

GistsUpdateResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

GitCreateBlobEndpoint

GitCreateBlobEndpoint: { content: string; encoding?: string; owner: string; repo: string }

Type declaration

  • content: string

    The new blob's content.

  • Optional encoding?: string

    The encoding used for content. Currently, "utf-8" and "base64" are supported.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

GitCreateBlobRequestOptions

GitCreateBlobRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/blobs" }

Type declaration

GitCreateBlobResponseData

GitCreateBlobResponseData: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

GitCreateCommitEndpoint

GitCreateCommitEndpoint: { author?: GitCreateCommitParamsAuthor; committer?: GitCreateCommitParamsCommitter; message: string; owner: string; parents: string[]; repo: string; signature?: string; tree: string }

Type declaration

  • Optional author?: GitCreateCommitParamsAuthor

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

  • Optional committer?: GitCreateCommitParamsCommitter

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

  • message: string

    The commit message

  • owner: string

    owner parameter

  • parents: string[]

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

  • repo: string

    repo parameter

  • Optional signature?: string

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

  • tree: string

    The SHA of the tree object this commit points to

GitCreateCommitParamsAuthor

GitCreateCommitParamsAuthor: { date?: string; email?: string; name?: string }

Type declaration

  • Optional date?: string
  • Optional email?: string
  • Optional name?: string

GitCreateCommitParamsCommitter

GitCreateCommitParamsCommitter: { date?: string; email?: string; name?: string }

Type declaration

  • Optional date?: string
  • Optional email?: string
  • Optional name?: string

GitCreateCommitRequestOptions

GitCreateCommitRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/commits" }

Type declaration

GitCreateCommitResponseData

GitCreateCommitResponseData: { author: GitCreateCommitResponseDataAuthor; committer: GitCreateCommitResponseDataCommitter; message: string; node_id: string; parents: Array<GitCreateCommitResponseDataParentsItem>; sha: string; tree: GitCreateCommitResponseDataTree; url: string; verification: GitCreateCommitResponseDataVerification }

Type declaration

GitCreateCommitResponseDataAuthor

GitCreateCommitResponseDataAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

GitCreateCommitResponseDataCommitter

GitCreateCommitResponseDataCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

GitCreateCommitResponseDataParentsItem

GitCreateCommitResponseDataParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

GitCreateCommitResponseDataTree

GitCreateCommitResponseDataTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

GitCreateCommitResponseDataVerification

GitCreateCommitResponseDataVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

GitCreateRefEndpoint

GitCreateRefEndpoint: { owner: string; ref: string; repo: string; sha: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

  • repo: string

    repo parameter

  • sha: string

    The SHA1 value for this reference.

GitCreateRefRequestOptions

GitCreateRefRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/refs" }

Type declaration

GitCreateRefResponseData

GitCreateRefResponseData: { node_id: string; object: GitCreateRefResponseDataObject; ref: string; url: string }

Type declaration

GitCreateRefResponseDataObject

GitCreateRefResponseDataObject: { sha: string; type: string; url: string }

Type declaration

  • sha: string
  • type: string
  • url: string

GitCreateTagEndpoint

GitCreateTagEndpoint: { message: string; object: string; owner: string; repo: string; tag: string; tagger?: GitCreateTagParamsTagger; type: "commit" | "tree" | "blob" }

Type declaration

  • message: string

    The tag message.

  • object: string

    The SHA of the git object this is tagging.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tag: string

    The tag's name. This is typically a version (e.g., "v0.0.1").

  • Optional tagger?: GitCreateTagParamsTagger

    An object with information about the individual creating the tag.

  • type: "commit" | "tree" | "blob"

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

GitCreateTagParamsTagger

GitCreateTagParamsTagger: { date?: string; email?: string; name?: string }

Type declaration

  • Optional date?: string
  • Optional email?: string
  • Optional name?: string

GitCreateTagRequestOptions

GitCreateTagRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/tags" }

Type declaration

GitCreateTagResponseData

GitCreateTagResponseData: { message: string; node_id: string; object: GitCreateTagResponseDataObject; sha: string; tag: string; tagger: GitCreateTagResponseDataTagger; url: string; verification: GitCreateTagResponseDataVerification }

Type declaration

GitCreateTagResponseDataObject

GitCreateTagResponseDataObject: { sha: string; type: string; url: string }

Type declaration

  • sha: string
  • type: string
  • url: string

GitCreateTagResponseDataTagger

GitCreateTagResponseDataTagger: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

GitCreateTagResponseDataVerification

GitCreateTagResponseDataVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

GitCreateTreeEndpoint

GitCreateTreeEndpoint: { base_tree?: string; owner: string; repo: string; tree: GitCreateTreeParamsTree[] }

Type declaration

  • Optional base_tree?: string

    The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tree: GitCreateTreeParamsTree[]

    Objects (of path, mode, type, and sha) specifying a tree structure.

GitCreateTreeParamsTree

GitCreateTreeParamsTree: { content?: string; mode?: "100644" | "100755" | "040000" | "160000" | "120000"; path?: string; sha?: string | null; type?: "blob" | "tree" | "commit" }

Type declaration

  • Optional content?: string
  • Optional mode?: "100644" | "100755" | "040000" | "160000" | "120000"
  • Optional path?: string
  • Optional sha?: string | null
  • Optional type?: "blob" | "tree" | "commit"

GitCreateTreeRequestOptions

GitCreateTreeRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/trees" }

Type declaration

GitCreateTreeResponseData

GitCreateTreeResponseData: { sha: string; tree: Array<GitCreateTreeResponseDataTreeItem>; url: string }

Type declaration

GitCreateTreeResponseDataTreeItem

GitCreateTreeResponseDataTreeItem: { mode: string; path: string; sha: string; size: number; type: string; url: string }

Type declaration

  • mode: string
  • path: string
  • sha: string
  • size: number
  • type: string
  • url: string

GitDeleteRefEndpoint

GitDeleteRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

GitDeleteRefRequestOptions

GitDeleteRefRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/refs/:ref" }

Type declaration

GitGetBlobEndpoint

GitGetBlobEndpoint: { file_sha: string; owner: string; repo: string }

Type declaration

  • file_sha: string

    file_sha parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

GitGetBlobRequestOptions

GitGetBlobRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/blobs/:file_sha" }

Type declaration

GitGetBlobResponseData

GitGetBlobResponseData: { content: string; encoding: string; sha: string; size: number; url: string }

Type declaration

  • content: string
  • encoding: string
  • sha: string
  • size: number
  • url: string

GitGetCommitEndpoint

GitGetCommitEndpoint: { commit_sha: string; owner: string; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

GitGetCommitRequestOptions

GitGetCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/commits/:commit_sha" }

Type declaration

GitGetCommitResponseData

GitGetCommitResponseData: { author: GitGetCommitResponseDataAuthor; committer: GitGetCommitResponseDataCommitter; message: string; parents: Array<GitGetCommitResponseDataParentsItem>; sha: string; tree: GitGetCommitResponseDataTree; url: string; verification: GitGetCommitResponseDataVerification }

Type declaration

GitGetCommitResponseDataAuthor

GitGetCommitResponseDataAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

GitGetCommitResponseDataCommitter

GitGetCommitResponseDataCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

GitGetCommitResponseDataParentsItem

GitGetCommitResponseDataParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

GitGetCommitResponseDataTree

GitGetCommitResponseDataTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

GitGetCommitResponseDataVerification

GitGetCommitResponseDataVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

GitGetRefEndpoint

GitGetRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

GitGetRefRequestOptions

GitGetRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/ref/:ref" }

Type declaration

GitGetRefResponseData

GitGetRefResponseData: { node_id: string; object: GitGetRefResponseDataObject; ref: string; url: string }

Type declaration

GitGetRefResponseDataObject

GitGetRefResponseDataObject: { sha: string; type: string; url: string }

Type declaration

  • sha: string
  • type: string
  • url: string

GitGetTagEndpoint

GitGetTagEndpoint: { owner: string; repo: string; tag_sha: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tag_sha: string

    tag_sha parameter

GitGetTagRequestOptions

GitGetTagRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/tags/:tag_sha" }

Type declaration

GitGetTagResponseData

GitGetTagResponseData: { message: string; node_id: string; object: GitGetTagResponseDataObject; sha: string; tag: string; tagger: GitGetTagResponseDataTagger; url: string; verification: GitGetTagResponseDataVerification }

Type declaration

GitGetTagResponseDataObject

GitGetTagResponseDataObject: { sha: string; type: string; url: string }

Type declaration

  • sha: string
  • type: string
  • url: string

GitGetTagResponseDataTagger

GitGetTagResponseDataTagger: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

GitGetTagResponseDataVerification

GitGetTagResponseDataVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

GitGetTreeEndpoint

GitGetTreeEndpoint: { owner: string; recursive?: "1"; repo: string; tree_sha: string }

Type declaration

  • owner: string

    owner parameter

  • Optional recursive?: "1"

    recursive parameter

  • repo: string

    repo parameter

  • tree_sha: string

    tree_sha parameter

GitGetTreeRequestOptions

GitGetTreeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/trees/:tree_sha" }

Type declaration

GitGetTreeResponseData

GitGetTreeResponseData: { sha: string; tree: Array<GitGetTreeResponseDataTreeItem>; truncated: boolean; url: string }

Type declaration

GitGetTreeResponseDataTreeItem

GitGetTreeResponseDataTreeItem: { mode: string; path: string; sha: string; size?: number; type: string; url: string }

Type declaration

  • mode: string
  • path: string
  • sha: string
  • Optional size?: number
  • type: string
  • url: string

GitListMatchingRefsEndpoint

GitListMatchingRefsEndpoint: { owner: string; page?: number; per_page?: number; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

GitListMatchingRefsRequestOptions

GitListMatchingRefsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/matching-refs/:ref" }

Type declaration

GitListMatchingRefsResponseData

GitListMatchingRefsResponseData: Array<GitListMatchingRefsResponseDataItem>

GitListMatchingRefsResponseDataItem

GitListMatchingRefsResponseDataItem: { node_id: string; object: GitListMatchingRefsResponseDataItemObject; ref: string; url: string }

Type declaration

GitListMatchingRefsResponseDataItemObject

GitListMatchingRefsResponseDataItemObject: { sha: string; type: string; url: string }

Type declaration

  • sha: string
  • type: string
  • url: string

GitUpdateRefEndpoint

GitUpdateRefEndpoint: { force?: boolean; owner: string; ref: string; repo: string; sha: string }

Type declaration

  • Optional force?: boolean

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

  • sha: string

    The SHA1 value to set this reference to

GitUpdateRefRequestOptions

GitUpdateRefRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/refs/:ref" }

Type declaration

GitUpdateRefResponseData

GitUpdateRefResponseData: { node_id: string; object: GitUpdateRefResponseDataObject; ref: string; url: string }

Type declaration

GitUpdateRefResponseDataObject

GitUpdateRefResponseDataObject: { sha: string; type: string; url: string }

Type declaration

  • sha: string
  • type: string
  • url: string

GitignoreGetTemplateEndpoint

GitignoreGetTemplateEndpoint: { name: string }

Type declaration

  • name: string

    name parameter

GitignoreGetTemplateRequestOptions

GitignoreGetTemplateRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gitignore/templates/:name" }

Type declaration

GitignoreGetTemplateResponseData

GitignoreGetTemplateResponseData: { name: string; source: string }

Type declaration

  • name: string
  • source: string

GitignoreListTemplatesEndpoint

GitignoreListTemplatesEndpoint: {}

Type declaration

GitignoreListTemplatesRequestOptions

GitignoreListTemplatesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gitignore/templates" }

Type declaration

GitignoreListTemplatesResponseData

GitignoreListTemplatesResponseData: Array<string>

InteractionsAddOrUpdateRestrictionsForOrgEndpoint

InteractionsAddOrUpdateRestrictionsForOrgEndpoint: { limit: "existing_users" | "contributors_only" | "collaborators_only"; org: string }

Type declaration

  • limit: "existing_users" | "contributors_only" | "collaborators_only"

    Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: existing_users, contributors_only, or collaborators_only.

  • org: string

    org parameter

InteractionsAddOrUpdateRestrictionsForOrgRequestOptions

InteractionsAddOrUpdateRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/interaction-limits" }

Type declaration

InteractionsAddOrUpdateRestrictionsForOrgResponseData

InteractionsAddOrUpdateRestrictionsForOrgResponseData: { expires_at: string; limit: string; origin: string }

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsAddOrUpdateRestrictionsForRepoEndpoint

InteractionsAddOrUpdateRestrictionsForRepoEndpoint: { limit: "existing_users" | "contributors_only" | "collaborators_only"; owner: string; repo: string }

Type declaration

  • limit: "existing_users" | "contributors_only" | "collaborators_only"

    Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: existing_users, contributors_only, or collaborators_only.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

InteractionsAddOrUpdateRestrictionsForRepoRequestOptions

InteractionsAddOrUpdateRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/interaction-limits" }

Type declaration

InteractionsAddOrUpdateRestrictionsForRepoResponseData

InteractionsAddOrUpdateRestrictionsForRepoResponseData: { expires_at: string; limit: string; origin: string }

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsGetRestrictionsForOrgEndpoint

InteractionsGetRestrictionsForOrgEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

InteractionsGetRestrictionsForOrgRequestOptions

InteractionsGetRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/interaction-limits" }

Type declaration

InteractionsGetRestrictionsForOrgResponseData

InteractionsGetRestrictionsForOrgResponseData: { expires_at: string; limit: string; origin: string }

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsGetRestrictionsForRepoEndpoint

InteractionsGetRestrictionsForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

InteractionsGetRestrictionsForRepoRequestOptions

InteractionsGetRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/interaction-limits" }

Type declaration

InteractionsGetRestrictionsForRepoResponseData

InteractionsGetRestrictionsForRepoResponseData: { expires_at: string; limit: string; origin: string }

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsRemoveRestrictionsForOrgEndpoint

InteractionsRemoveRestrictionsForOrgEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

InteractionsRemoveRestrictionsForOrgRequestOptions

InteractionsRemoveRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/interaction-limits" }

Type declaration

InteractionsRemoveRestrictionsForRepoEndpoint

InteractionsRemoveRestrictionsForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

InteractionsRemoveRestrictionsForRepoRequestOptions

InteractionsRemoveRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/interaction-limits" }

Type declaration

IssuesAddAssigneesEndpoint

IssuesAddAssigneesEndpoint: { assignees?: string[]; issue_number: number; owner: string; repo: string }

Type declaration

  • Optional assignees?: string[]

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesAddAssigneesRequestOptions

IssuesAddAssigneesRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/assignees" }

Type declaration

IssuesAddAssigneesResponseData

IssuesAddAssigneesResponseData: { active_lock_reason: string; assignee: IssuesAddAssigneesResponseDataAssignee; assignees: Array<IssuesAddAssigneesResponseDataAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesAddAssigneesResponseDataLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesAddAssigneesResponseDataMilestone; node_id: string; number: number; pull_request: IssuesAddAssigneesResponseDataPullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesAddAssigneesResponseDataUser }

Type declaration

IssuesAddAssigneesResponseDataAssignee

IssuesAddAssigneesResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesAddAssigneesResponseDataAssigneesItem

IssuesAddAssigneesResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesAddAssigneesResponseDataLabelsItem

IssuesAddAssigneesResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesAddAssigneesResponseDataMilestone

IssuesAddAssigneesResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesAddAssigneesResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesAddAssigneesResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesAddAssigneesResponseDataMilestoneCreator

IssuesAddAssigneesResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesAddAssigneesResponseDataPullRequest

IssuesAddAssigneesResponseDataPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesAddAssigneesResponseDataUser

IssuesAddAssigneesResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesAddLabelsEndpoint

IssuesAddLabelsEndpoint: { issue_number: number; labels: string[]; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • labels: string[]

    The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesAddLabelsRequestOptions

IssuesAddLabelsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesAddLabelsResponseData

IssuesAddLabelsResponseData: Array<IssuesAddLabelsResponseDataItem>

IssuesAddLabelsResponseDataItem

IssuesAddLabelsResponseDataItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesCheckAssigneeEndpoint

IssuesCheckAssigneeEndpoint: { assignee: string; owner: string; repo: string }

Type declaration

  • assignee: string

    assignee parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesCheckAssigneeRequestOptions

IssuesCheckAssigneeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/assignees/:assignee" }

Type declaration

IssuesCreateCommentEndpoint

IssuesCreateCommentEndpoint: { body: string; issue_number: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesCreateCommentRequestOptions

IssuesCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/comments" }

Type declaration

IssuesCreateCommentResponseData

IssuesCreateCommentResponseData: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesCreateCommentResponseDataUser }

Type declaration

IssuesCreateCommentResponseDataUser

IssuesCreateCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesCreateEndpoint

IssuesCreateEndpoint: { assignee?: string; assignees?: string[]; body?: string; labels?: string[]; milestone?: number; owner: string; repo: string; title: string }

Type declaration

  • Optional assignee?: string

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: string

    The contents of the issue.

  • Optional labels?: string[]

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

  • Optional milestone?: number

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • title: string

    The title of the issue.

IssuesCreateLabelEndpoint

IssuesCreateLabelEndpoint: { color: string; description?: string; name: string; owner: string; repo: string }

Type declaration

  • color: string

    The hexadecimal color code for the label, without the leading #.

  • Optional description?: string

    A short description of the label.

  • name: string

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesCreateLabelRequestOptions

IssuesCreateLabelRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels" }

Type declaration

IssuesCreateLabelResponseData

IssuesCreateLabelResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesCreateMilestoneEndpoint

IssuesCreateMilestoneEndpoint: { description?: string; due_on?: string; owner: string; repo: string; state?: "open" | "closed"; title: string }

Type declaration

  • Optional description?: string

    A description of the milestone.

  • Optional due_on?: string

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • title: string

    The title of the milestone.

IssuesCreateMilestoneRequestOptions

IssuesCreateMilestoneRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones" }

Type declaration

IssuesCreateMilestoneResponseData

IssuesCreateMilestoneResponseData: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesCreateMilestoneResponseDataCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesCreateMilestoneResponseDataCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesCreateMilestoneResponseDataCreator

IssuesCreateMilestoneResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesCreateRequestOptions

IssuesCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues" }

Type declaration

IssuesCreateResponseData

IssuesCreateResponseData: { active_lock_reason: string; assignee: IssuesCreateResponseDataAssignee; assignees: Array<IssuesCreateResponseDataAssigneesItem>; body: string; closed_at: null; closed_by: IssuesCreateResponseDataClosedBy; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesCreateResponseDataLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesCreateResponseDataMilestone; node_id: string; number: number; pull_request: IssuesCreateResponseDataPullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesCreateResponseDataUser }

Type declaration

IssuesCreateResponseDataAssignee

IssuesCreateResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesCreateResponseDataAssigneesItem

IssuesCreateResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesCreateResponseDataClosedBy

IssuesCreateResponseDataClosedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesCreateResponseDataLabelsItem

IssuesCreateResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesCreateResponseDataMilestone

IssuesCreateResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesCreateResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesCreateResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesCreateResponseDataMilestoneCreator

IssuesCreateResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesCreateResponseDataPullRequest

IssuesCreateResponseDataPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesCreateResponseDataUser

IssuesCreateResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesDeleteCommentEndpoint

IssuesDeleteCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesDeleteCommentRequestOptions

IssuesDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id" }

Type declaration

IssuesDeleteLabelEndpoint

IssuesDeleteLabelEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesDeleteLabelRequestOptions

IssuesDeleteLabelRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels/:name" }

Type declaration

IssuesDeleteMilestoneEndpoint

IssuesDeleteMilestoneEndpoint: { milestone_number: number; owner: string; repo: string }

Type declaration

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesDeleteMilestoneRequestOptions

IssuesDeleteMilestoneRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number" }

Type declaration

IssuesGetCommentEndpoint

IssuesGetCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetCommentRequestOptions

IssuesGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id" }

Type declaration

IssuesGetCommentResponseData

IssuesGetCommentResponseData: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesGetCommentResponseDataUser }

Type declaration

IssuesGetCommentResponseDataUser

IssuesGetCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetEndpoint

IssuesGetEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetEventEndpoint

IssuesGetEventEndpoint: { event_id: number; owner: string; repo: string }

Type declaration

  • event_id: number

    event_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetEventRequestOptions

IssuesGetEventRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/events/:event_id" }

Type declaration

IssuesGetEventResponseData

IssuesGetEventResponseData: { actor: IssuesGetEventResponseDataActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; issue: IssuesGetEventResponseDataIssue; node_id: string; url: string }

Type declaration

IssuesGetEventResponseDataActor

IssuesGetEventResponseDataActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetEventResponseDataIssue

IssuesGetEventResponseDataIssue: { active_lock_reason: string; assignee: IssuesGetEventResponseDataIssueAssignee; assignees: Array<IssuesGetEventResponseDataIssueAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesGetEventResponseDataIssueLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesGetEventResponseDataIssueMilestone; node_id: string; number: number; pull_request: IssuesGetEventResponseDataIssuePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesGetEventResponseDataIssueUser }

Type declaration

IssuesGetEventResponseDataIssueAssignee

IssuesGetEventResponseDataIssueAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetEventResponseDataIssueAssigneesItem

IssuesGetEventResponseDataIssueAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetEventResponseDataIssueLabelsItem

IssuesGetEventResponseDataIssueLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesGetEventResponseDataIssueMilestone

IssuesGetEventResponseDataIssueMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesGetEventResponseDataIssueMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesGetEventResponseDataIssueMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesGetEventResponseDataIssueMilestoneCreator

IssuesGetEventResponseDataIssueMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetEventResponseDataIssuePullRequest

IssuesGetEventResponseDataIssuePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesGetEventResponseDataIssueUser

IssuesGetEventResponseDataIssueUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetLabelEndpoint

IssuesGetLabelEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetLabelRequestOptions

IssuesGetLabelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels/:name" }

Type declaration

IssuesGetLabelResponseData

IssuesGetLabelResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesGetMilestoneEndpoint

IssuesGetMilestoneEndpoint: { milestone_number: number; owner: string; repo: string }

Type declaration

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetMilestoneRequestOptions

IssuesGetMilestoneRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number" }

Type declaration

IssuesGetMilestoneResponseData

IssuesGetMilestoneResponseData: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesGetMilestoneResponseDataCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesGetMilestoneResponseDataCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesGetMilestoneResponseDataCreator

IssuesGetMilestoneResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetRequestOptions

IssuesGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number" }

Type declaration

IssuesGetResponseData

IssuesGetResponseData: { active_lock_reason: string; assignee: IssuesGetResponseDataAssignee; assignees: Array<IssuesGetResponseDataAssigneesItem>; body: string; closed_at: null; closed_by: IssuesGetResponseDataClosedBy; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesGetResponseDataLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesGetResponseDataMilestone; node_id: string; number: number; pull_request: IssuesGetResponseDataPullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesGetResponseDataUser }

Type declaration

IssuesGetResponseDataAssignee

IssuesGetResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetResponseDataAssigneesItem

IssuesGetResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetResponseDataClosedBy

IssuesGetResponseDataClosedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetResponseDataLabelsItem

IssuesGetResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesGetResponseDataMilestone

IssuesGetResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesGetResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesGetResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesGetResponseDataMilestoneCreator

IssuesGetResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesGetResponseDataPullRequest

IssuesGetResponseDataPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesGetResponseDataUser

IssuesGetResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListAssigneesEndpoint

IssuesListAssigneesEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListAssigneesRequestOptions

IssuesListAssigneesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/assignees" }

Type declaration

IssuesListAssigneesResponseData

IssuesListAssigneesResponseData: Array<IssuesListAssigneesResponseDataItem>

IssuesListAssigneesResponseDataItem

IssuesListAssigneesResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListCommentsEndpoint

IssuesListCommentsEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string; since?: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

IssuesListCommentsForRepoEndpoint

IssuesListCommentsForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; repo: string; since?: string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Either asc or desc. Ignored without the sort parameter.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated"

    Either created or updated.

IssuesListCommentsForRepoRequestOptions

IssuesListCommentsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments" }

Type declaration

IssuesListCommentsForRepoResponseData

IssuesListCommentsForRepoResponseData: Array<IssuesListCommentsForRepoResponseDataItem>

IssuesListCommentsForRepoResponseDataItem

IssuesListCommentsForRepoResponseDataItem: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesListCommentsForRepoResponseDataItemUser }

Type declaration

IssuesListCommentsForRepoResponseDataItemUser

IssuesListCommentsForRepoResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListCommentsRequestOptions

IssuesListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/comments" }

Type declaration

IssuesListCommentsResponseData

IssuesListCommentsResponseData: Array<IssuesListCommentsResponseDataItem>

IssuesListCommentsResponseDataItem

IssuesListCommentsResponseDataItem: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesListCommentsResponseDataItemUser }

Type declaration

IssuesListCommentsResponseDataItemUser

IssuesListCommentsResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListEndpoint

IssuesListEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: string; page?: number; per_page?: number; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListEventsEndpoint

IssuesListEventsEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListEventsForRepoEndpoint

IssuesListEventsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListEventsForRepoRequestOptions

IssuesListEventsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/events" }

Type declaration

IssuesListEventsForRepoResponseData

IssuesListEventsForRepoResponseData: Array<IssuesListEventsForRepoResponseDataItem>

IssuesListEventsForRepoResponseDataItem

IssuesListEventsForRepoResponseDataItem: { actor: IssuesListEventsForRepoResponseDataItemActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; issue: IssuesListEventsForRepoResponseDataItemIssue; node_id: string; url: string }

Type declaration

IssuesListEventsForRepoResponseDataItemActor

IssuesListEventsForRepoResponseDataItemActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListEventsForRepoResponseDataItemIssue

IssuesListEventsForRepoResponseDataItemIssue: { active_lock_reason: string; assignee: IssuesListEventsForRepoResponseDataItemIssueAssignee; assignees: Array<IssuesListEventsForRepoResponseDataItemIssueAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListEventsForRepoResponseDataItemIssueLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListEventsForRepoResponseDataItemIssueMilestone; node_id: string; number: number; pull_request: IssuesListEventsForRepoResponseDataItemIssuePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListEventsForRepoResponseDataItemIssueUser }

Type declaration

IssuesListEventsForRepoResponseDataItemIssueAssignee

IssuesListEventsForRepoResponseDataItemIssueAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListEventsForRepoResponseDataItemIssueAssigneesItem

IssuesListEventsForRepoResponseDataItemIssueAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListEventsForRepoResponseDataItemIssueLabelsItem

IssuesListEventsForRepoResponseDataItemIssueLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListEventsForRepoResponseDataItemIssueMilestone

IssuesListEventsForRepoResponseDataItemIssueMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator

IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListEventsForRepoResponseDataItemIssuePullRequest

IssuesListEventsForRepoResponseDataItemIssuePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesListEventsForRepoResponseDataItemIssueUser

IssuesListEventsForRepoResponseDataItemIssueUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListEventsForTimelineEndpoint

IssuesListEventsForTimelineEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListEventsForTimelineRequestOptions

IssuesListEventsForTimelineRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/timeline" }

Type declaration

IssuesListEventsForTimelineResponseData

IssuesListEventsForTimelineResponseData: Array<IssuesListEventsForTimelineResponseDataItem>

IssuesListEventsForTimelineResponseDataItem

IssuesListEventsForTimelineResponseDataItem: { actor: IssuesListEventsForTimelineResponseDataItemActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; node_id: string; url: string }

Type declaration

IssuesListEventsForTimelineResponseDataItemActor

IssuesListEventsForTimelineResponseDataItemActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListEventsRequestOptions

IssuesListEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/events" }

Type declaration

IssuesListEventsResponseData

IssuesListEventsResponseData: Array<IssuesListEventsResponseDataItem>

IssuesListEventsResponseDataItem

IssuesListEventsResponseDataItem: { actor: IssuesListEventsResponseDataItemActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; node_id: string; url: string }

Type declaration

IssuesListEventsResponseDataItemActor

IssuesListEventsResponseDataItemActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForAuthenticatedUserEndpoint

IssuesListForAuthenticatedUserEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: string; page?: number; per_page?: number; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForAuthenticatedUserRequestOptions

IssuesListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/issues" }

Type declaration

IssuesListForAuthenticatedUserResponseData

IssuesListForAuthenticatedUserResponseData: Array<IssuesListForAuthenticatedUserResponseDataItem>

IssuesListForAuthenticatedUserResponseDataItem

IssuesListForAuthenticatedUserResponseDataItem: { active_lock_reason: string; assignee: IssuesListForAuthenticatedUserResponseDataItemAssignee; assignees: Array<IssuesListForAuthenticatedUserResponseDataItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListForAuthenticatedUserResponseDataItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListForAuthenticatedUserResponseDataItemMilestone; node_id: string; number: number; pull_request: IssuesListForAuthenticatedUserResponseDataItemPullRequest; repository: IssuesListForAuthenticatedUserResponseDataItemRepository; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListForAuthenticatedUserResponseDataItemUser }

Type declaration

IssuesListForAuthenticatedUserResponseDataItemAssignee

IssuesListForAuthenticatedUserResponseDataItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForAuthenticatedUserResponseDataItemAssigneesItem

IssuesListForAuthenticatedUserResponseDataItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForAuthenticatedUserResponseDataItemLabelsItem

IssuesListForAuthenticatedUserResponseDataItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListForAuthenticatedUserResponseDataItemMilestone

IssuesListForAuthenticatedUserResponseDataItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator

IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForAuthenticatedUserResponseDataItemPullRequest

IssuesListForAuthenticatedUserResponseDataItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesListForAuthenticatedUserResponseDataItemRepository

IssuesListForAuthenticatedUserResponseDataItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner; permissions: IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner
  • permissions: IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner

IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions

IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

IssuesListForAuthenticatedUserResponseDataItemUser

IssuesListForAuthenticatedUserResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForOrgEndpoint

IssuesListForOrgEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: string; org: string; page?: number; per_page?: number; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForOrgRequestOptions

IssuesListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/issues" }

Type declaration

IssuesListForOrgResponseData

IssuesListForOrgResponseData: Array<IssuesListForOrgResponseDataItem>

IssuesListForOrgResponseDataItem

IssuesListForOrgResponseDataItem: { active_lock_reason: string; assignee: IssuesListForOrgResponseDataItemAssignee; assignees: Array<IssuesListForOrgResponseDataItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListForOrgResponseDataItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListForOrgResponseDataItemMilestone; node_id: string; number: number; pull_request: IssuesListForOrgResponseDataItemPullRequest; repository: IssuesListForOrgResponseDataItemRepository; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListForOrgResponseDataItemUser }

Type declaration

IssuesListForOrgResponseDataItemAssignee

IssuesListForOrgResponseDataItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForOrgResponseDataItemAssigneesItem

IssuesListForOrgResponseDataItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForOrgResponseDataItemLabelsItem

IssuesListForOrgResponseDataItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListForOrgResponseDataItemMilestone

IssuesListForOrgResponseDataItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListForOrgResponseDataItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListForOrgResponseDataItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListForOrgResponseDataItemMilestoneCreator

IssuesListForOrgResponseDataItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForOrgResponseDataItemPullRequest

IssuesListForOrgResponseDataItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesListForOrgResponseDataItemRepository

IssuesListForOrgResponseDataItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: IssuesListForOrgResponseDataItemRepositoryOwner; permissions: IssuesListForOrgResponseDataItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: IssuesListForOrgResponseDataItemRepositoryOwner
  • permissions: IssuesListForOrgResponseDataItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

IssuesListForOrgResponseDataItemRepositoryOwner

IssuesListForOrgResponseDataItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForOrgResponseDataItemRepositoryPermissions

IssuesListForOrgResponseDataItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

IssuesListForOrgResponseDataItemUser

IssuesListForOrgResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForRepoEndpoint

IssuesListForRepoEndpoint: { assignee?: string; creator?: string; direction?: "asc" | "desc"; labels?: string; mentioned?: string; milestone?: string; owner: string; page?: number; per_page?: number; repo: string; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional assignee?: string

    Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

  • Optional creator?: string

    The user that created the issue.

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional mentioned?: string

    A user that's mentioned in the issue.

  • Optional milestone?: string

    If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForRepoRequestOptions

IssuesListForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues" }

Type declaration

IssuesListForRepoResponseData

IssuesListForRepoResponseData: Array<IssuesListForRepoResponseDataItem>

IssuesListForRepoResponseDataItem

IssuesListForRepoResponseDataItem: { active_lock_reason: string; assignee: IssuesListForRepoResponseDataItemAssignee; assignees: Array<IssuesListForRepoResponseDataItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListForRepoResponseDataItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListForRepoResponseDataItemMilestone; node_id: string; number: number; pull_request: IssuesListForRepoResponseDataItemPullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListForRepoResponseDataItemUser }

Type declaration

IssuesListForRepoResponseDataItemAssignee

IssuesListForRepoResponseDataItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForRepoResponseDataItemAssigneesItem

IssuesListForRepoResponseDataItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForRepoResponseDataItemLabelsItem

IssuesListForRepoResponseDataItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListForRepoResponseDataItemMilestone

IssuesListForRepoResponseDataItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListForRepoResponseDataItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListForRepoResponseDataItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListForRepoResponseDataItemMilestoneCreator

IssuesListForRepoResponseDataItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListForRepoResponseDataItemPullRequest

IssuesListForRepoResponseDataItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesListForRepoResponseDataItemUser

IssuesListForRepoResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListLabelsForMilestoneEndpoint

IssuesListLabelsForMilestoneEndpoint: { milestone_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListLabelsForMilestoneRequestOptions

IssuesListLabelsForMilestoneRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number/labels" }

Type declaration

IssuesListLabelsForMilestoneResponseData

IssuesListLabelsForMilestoneResponseData: Array<IssuesListLabelsForMilestoneResponseDataItem>

IssuesListLabelsForMilestoneResponseDataItem

IssuesListLabelsForMilestoneResponseDataItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListLabelsForRepoEndpoint

IssuesListLabelsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListLabelsForRepoRequestOptions

IssuesListLabelsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels" }

Type declaration

IssuesListLabelsForRepoResponseData

IssuesListLabelsForRepoResponseData: Array<IssuesListLabelsForRepoResponseDataItem>

IssuesListLabelsForRepoResponseDataItem

IssuesListLabelsForRepoResponseDataItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListLabelsOnIssueEndpoint

IssuesListLabelsOnIssueEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListLabelsOnIssueRequestOptions

IssuesListLabelsOnIssueRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesListLabelsOnIssueResponseData

IssuesListLabelsOnIssueResponseData: Array<IssuesListLabelsOnIssueResponseDataItem>

IssuesListLabelsOnIssueResponseDataItem

IssuesListLabelsOnIssueResponseDataItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListMilestonesForRepoEndpoint

IssuesListMilestonesForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; repo: string; sort?: "due_on" | "completeness"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Either asc or desc.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sort?: "due_on" | "completeness"

    What to sort results by. Either due_on or completeness.

  • Optional state?: "open" | "closed" | "all"

    The state of the milestone. Either open, closed, or all.

IssuesListMilestonesForRepoRequestOptions

IssuesListMilestonesForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones" }

Type declaration

IssuesListMilestonesForRepoResponseData

IssuesListMilestonesForRepoResponseData: Array<IssuesListMilestonesForRepoResponseDataItem>

IssuesListMilestonesForRepoResponseDataItem

IssuesListMilestonesForRepoResponseDataItem: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListMilestonesForRepoResponseDataItemCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListMilestonesForRepoResponseDataItemCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListMilestonesForRepoResponseDataItemCreator

IssuesListMilestonesForRepoResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListRequestOptions

IssuesListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/issues" }

Type declaration

IssuesListResponseData

IssuesListResponseData: Array<IssuesListResponseDataItem>

IssuesListResponseDataItem

IssuesListResponseDataItem: { active_lock_reason: string; assignee: IssuesListResponseDataItemAssignee; assignees: Array<IssuesListResponseDataItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListResponseDataItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListResponseDataItemMilestone; node_id: string; number: number; pull_request: IssuesListResponseDataItemPullRequest; repository: IssuesListResponseDataItemRepository; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListResponseDataItemUser }

Type declaration

IssuesListResponseDataItemAssignee

IssuesListResponseDataItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListResponseDataItemAssigneesItem

IssuesListResponseDataItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListResponseDataItemLabelsItem

IssuesListResponseDataItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesListResponseDataItemMilestone

IssuesListResponseDataItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListResponseDataItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListResponseDataItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListResponseDataItemMilestoneCreator

IssuesListResponseDataItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListResponseDataItemPullRequest

IssuesListResponseDataItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesListResponseDataItemRepository

IssuesListResponseDataItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: IssuesListResponseDataItemRepositoryOwner; permissions: IssuesListResponseDataItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: IssuesListResponseDataItemRepositoryOwner
  • permissions: IssuesListResponseDataItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

IssuesListResponseDataItemRepositoryOwner

IssuesListResponseDataItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesListResponseDataItemRepositoryPermissions

IssuesListResponseDataItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

IssuesListResponseDataItemUser

IssuesListResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesLockEndpoint

IssuesLockEndpoint: { issue_number: number; lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • Optional lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesLockRequestOptions

IssuesLockRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/lock" }

Type declaration

IssuesRemoveAllLabelsEndpoint

IssuesRemoveAllLabelsEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesRemoveAllLabelsRequestOptions

IssuesRemoveAllLabelsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesRemoveAssigneesEndpoint

IssuesRemoveAssigneesEndpoint: { assignees?: string[]; issue_number: number; owner: string; repo: string }

Type declaration

  • Optional assignees?: string[]

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesRemoveAssigneesRequestOptions

IssuesRemoveAssigneesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/assignees" }

Type declaration

IssuesRemoveAssigneesResponseData

IssuesRemoveAssigneesResponseData: { active_lock_reason: string; assignee: IssuesRemoveAssigneesResponseDataAssignee; assignees: Array<IssuesRemoveAssigneesResponseDataAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesRemoveAssigneesResponseDataLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesRemoveAssigneesResponseDataMilestone; node_id: string; number: number; pull_request: IssuesRemoveAssigneesResponseDataPullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesRemoveAssigneesResponseDataUser }

Type declaration

IssuesRemoveAssigneesResponseDataAssignee

IssuesRemoveAssigneesResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesRemoveAssigneesResponseDataAssigneesItem

IssuesRemoveAssigneesResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesRemoveAssigneesResponseDataLabelsItem

IssuesRemoveAssigneesResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesRemoveAssigneesResponseDataMilestone

IssuesRemoveAssigneesResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesRemoveAssigneesResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesRemoveAssigneesResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesRemoveAssigneesResponseDataMilestoneCreator

IssuesRemoveAssigneesResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesRemoveAssigneesResponseDataPullRequest

IssuesRemoveAssigneesResponseDataPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesRemoveAssigneesResponseDataUser

IssuesRemoveAssigneesResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesRemoveLabelEndpoint

IssuesRemoveLabelEndpoint: { issue_number: number; name: string; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesRemoveLabelRequestOptions

IssuesRemoveLabelRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels/:name" }

Type declaration

IssuesRemoveLabelResponseData

IssuesRemoveLabelResponseData: Array<IssuesRemoveLabelResponseDataItem>

IssuesRemoveLabelResponseDataItem

IssuesRemoveLabelResponseDataItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesReplaceAllLabelsEndpoint

IssuesReplaceAllLabelsEndpoint: { issue_number: number; labels?: string[]; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • Optional labels?: string[]

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesReplaceAllLabelsRequestOptions

IssuesReplaceAllLabelsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesReplaceAllLabelsResponseData

IssuesReplaceAllLabelsResponseData: Array<IssuesReplaceAllLabelsResponseDataItem>

IssuesReplaceAllLabelsResponseDataItem

IssuesReplaceAllLabelsResponseDataItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesUnlockEndpoint

IssuesUnlockEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesUnlockRequestOptions

IssuesUnlockRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/lock" }

Type declaration

IssuesUpdateCommentEndpoint

IssuesUpdateCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesUpdateCommentRequestOptions

IssuesUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id" }

Type declaration

IssuesUpdateCommentResponseData

IssuesUpdateCommentResponseData: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesUpdateCommentResponseDataUser }

Type declaration

IssuesUpdateCommentResponseDataUser

IssuesUpdateCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesUpdateEndpoint

IssuesUpdateEndpoint: { assignee?: string; assignees?: string[]; body?: string; issue_number: number; labels?: string[]; milestone?: number | null; owner: string; repo: string; state?: "open" | "closed"; title?: string }

Type declaration

  • Optional assignee?: string

    Login for the user that this issue should be assigned to. This field is deprecated.

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: string

    The contents of the issue.

  • issue_number: number

    issue_number parameter

  • Optional labels?: string[]

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

  • Optional milestone?: number | null

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    State of the issue. Either open or closed.

  • Optional title?: string

    The title of the issue.

IssuesUpdateLabelEndpoint

IssuesUpdateLabelEndpoint: { color?: string; description?: string; name: string; new_name?: string; owner: string; repo: string }

Type declaration

  • Optional color?: string

    The hexadecimal color code for the label, without the leading #.

  • Optional description?: string

    A short description of the label.

  • name: string

    name parameter

  • Optional new_name?: string

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesUpdateLabelRequestOptions

IssuesUpdateLabelRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels/:name" }

Type declaration

IssuesUpdateLabelResponseData

IssuesUpdateLabelResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesUpdateMilestoneEndpoint

IssuesUpdateMilestoneEndpoint: { description?: string; due_on?: string; milestone_number: number; owner: string; repo: string; state?: "open" | "closed"; title?: string }

Type declaration

  • Optional description?: string

    A description of the milestone.

  • Optional due_on?: string

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • Optional title?: string

    The title of the milestone.

IssuesUpdateMilestoneRequestOptions

IssuesUpdateMilestoneRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number" }

Type declaration

IssuesUpdateMilestoneResponseData

IssuesUpdateMilestoneResponseData: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesUpdateMilestoneResponseDataCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesUpdateMilestoneResponseDataCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesUpdateMilestoneResponseDataCreator

IssuesUpdateMilestoneResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesUpdateRequestOptions

IssuesUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number" }

Type declaration

IssuesUpdateResponseData

IssuesUpdateResponseData: { active_lock_reason: string; assignee: IssuesUpdateResponseDataAssignee; assignees: Array<IssuesUpdateResponseDataAssigneesItem>; body: string; closed_at: null; closed_by: IssuesUpdateResponseDataClosedBy; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesUpdateResponseDataLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesUpdateResponseDataMilestone; node_id: string; number: number; pull_request: IssuesUpdateResponseDataPullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesUpdateResponseDataUser }

Type declaration

IssuesUpdateResponseDataAssignee

IssuesUpdateResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesUpdateResponseDataAssigneesItem

IssuesUpdateResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesUpdateResponseDataClosedBy

IssuesUpdateResponseDataClosedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesUpdateResponseDataLabelsItem

IssuesUpdateResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

IssuesUpdateResponseDataMilestone

IssuesUpdateResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesUpdateResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesUpdateResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesUpdateResponseDataMilestoneCreator

IssuesUpdateResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

IssuesUpdateResponseDataPullRequest

IssuesUpdateResponseDataPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

Type declaration

  • diff_url: string
  • html_url: string
  • patch_url: string
  • url: string

IssuesUpdateResponseDataUser

IssuesUpdateResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

LicensesGetEndpoint

LicensesGetEndpoint: { license: string }

Type declaration

  • license: string

    license parameter

LicensesGetForRepoEndpoint

LicensesGetForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

LicensesGetForRepoRequestOptions

LicensesGetForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/license" }

Type declaration

LicensesGetForRepoResponseData

LicensesGetForRepoResponseData: { _links: LicensesGetForRepoResponseDataLinks; content: string; download_url: string; encoding: string; git_url: string; html_url: string; license: LicensesGetForRepoResponseDataLicense; name: string; path: string; sha: string; size: number; type: string; url: string }

Type declaration

LicensesGetForRepoResponseDataLicense

LicensesGetForRepoResponseDataLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

LicensesGetForRepoResponseDataLinks

LicensesGetForRepoResponseDataLinks: { git: string; html: string; self: string }

Type declaration

  • git: string
  • html: string
  • self: string

LicensesGetRequestOptions

LicensesGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/licenses/:license" }

Type declaration

LicensesGetResponseData

LicensesGetResponseData: { body: string; conditions: Array<string>; description: string; featured: boolean; html_url: string; implementation: string; key: string; limitations: Array<string>; name: string; node_id: string; permissions: Array<string>; spdx_id: string; url: string }

Type declaration

  • body: string
  • conditions: Array<string>
  • description: string
  • featured: boolean
  • html_url: string
  • implementation: string
  • key: string
  • limitations: Array<string>
  • name: string
  • node_id: string
  • permissions: Array<string>
  • spdx_id: string
  • url: string

LicensesListCommonlyUsedEndpoint

LicensesListCommonlyUsedEndpoint: {}

Type declaration

LicensesListCommonlyUsedRequestOptions

LicensesListCommonlyUsedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/licenses" }

Type declaration

LicensesListCommonlyUsedResponseData

LicensesListCommonlyUsedResponseData: Array<LicensesListCommonlyUsedResponseDataItem>

LicensesListCommonlyUsedResponseDataItem

LicensesListCommonlyUsedResponseDataItem: { key: string; name: string; node_id?: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • Optional node_id?: string
  • spdx_id: string
  • url: string

MarkdownRenderEndpoint

MarkdownRenderEndpoint: { context?: string; mode?: "markdown" | "gfm"; text: string }

Type declaration

  • Optional context?: string

    The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

  • Optional mode?: "markdown" | "gfm"

    The rendering mode. Can be either: * markdown to render a document in plain Markdown, just like README.md files are rendered. * gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

  • text: string

    The Markdown text to render in HTML. Markdown content must be 400 KB or less.

MarkdownRenderRawEndpoint

MarkdownRenderRawEndpoint: { data: string }

Type declaration

  • data: string

    data parameter

MarkdownRenderRawRequestOptions

MarkdownRenderRawRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/markdown/raw" }

Type declaration

MarkdownRenderRequestOptions

MarkdownRenderRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/markdown" }

Type declaration

MetaGetEndpoint

MetaGetEndpoint: {}

Type declaration

MetaGetRequestOptions

MetaGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/meta" }

Type declaration

MetaGetResponseData

MetaGetResponseData: { api: Array<string>; git: Array<string>; hooks: Array<string>; importer: Array<string>; pages: Array<string>; ssh_key_fingerprints: MetaGetResponseDataSshKeyFingerprints; verifiable_password_authentication: boolean; web: Array<string> }

Type declaration

  • api: Array<string>
  • git: Array<string>
  • hooks: Array<string>
  • importer: Array<string>
  • pages: Array<string>
  • ssh_key_fingerprints: MetaGetResponseDataSshKeyFingerprints
  • verifiable_password_authentication: boolean
  • web: Array<string>

MetaGetResponseDataSshKeyFingerprints

MetaGetResponseDataSshKeyFingerprints: { MD5_DSA: string; MD5_RSA: string; SHA256_DSA: string; SHA256_RSA: string }

Type declaration

  • MD5_DSA: string
  • MD5_RSA: string
  • SHA256_DSA: string
  • SHA256_RSA: string

MigrationsCancelImportEndpoint

MigrationsCancelImportEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsCancelImportRequestOptions

MigrationsCancelImportRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

MigrationsDeleteArchiveForAuthenticatedUserEndpoint

MigrationsDeleteArchiveForAuthenticatedUserEndpoint: { migration_id: number }

Type declaration

  • migration_id: number

    migration_id parameter

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/migrations/:migration_id/archive" }

Type declaration

MigrationsDeleteArchiveForOrgEndpoint

MigrationsDeleteArchiveForOrgEndpoint: { migration_id: number; org: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

MigrationsDeleteArchiveForOrgRequestOptions

MigrationsDeleteArchiveForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/archive" }

Type declaration

MigrationsDownloadArchiveForOrgEndpoint

MigrationsDownloadArchiveForOrgEndpoint: { migration_id: number; org: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

MigrationsDownloadArchiveForOrgRequestOptions

MigrationsDownloadArchiveForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/archive" }

Type declaration

MigrationsGetArchiveForAuthenticatedUserEndpoint

MigrationsGetArchiveForAuthenticatedUserEndpoint: { migration_id: number }

Type declaration

  • migration_id: number

    migration_id parameter

MigrationsGetArchiveForAuthenticatedUserRequestOptions

MigrationsGetArchiveForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/migrations/:migration_id/archive" }

Type declaration

MigrationsGetCommitAuthorsEndpoint

MigrationsGetCommitAuthorsEndpoint: { owner: string; repo: string; since?: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional since?: string

    Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the raw step.

MigrationsGetCommitAuthorsRequestOptions

MigrationsGetCommitAuthorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/authors" }

Type declaration

MigrationsGetCommitAuthorsResponseData

MigrationsGetCommitAuthorsResponseData: Array<MigrationsGetCommitAuthorsResponseDataItem>

MigrationsGetCommitAuthorsResponseDataItem

MigrationsGetCommitAuthorsResponseDataItem: { email: string; id: number; import_url: string; name: string; remote_id: string; remote_name: string; url: string }

Type declaration

  • email: string
  • id: number
  • import_url: string
  • name: string
  • remote_id: string
  • remote_name: string
  • url: string

MigrationsGetImportProgressEndpoint

MigrationsGetImportProgressEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsGetImportProgressRequestOptions

MigrationsGetImportProgressRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

MigrationsGetImportProgressResponseData

MigrationsGetImportProgressResponseData: { authors_count: number; authors_url: string; has_large_files: boolean; html_url: string; large_files_count: number; large_files_size: number; repository_url: string; status: string; status_text: string; url: string; use_lfs: string; vcs: string; vcs_url: string }

Type declaration

  • authors_count: number
  • authors_url: string
  • has_large_files: boolean
  • html_url: string
  • large_files_count: number
  • large_files_size: number
  • repository_url: string
  • status: string
  • status_text: string
  • url: string
  • use_lfs: string
  • vcs: string
  • vcs_url: string

MigrationsGetLargeFilesEndpoint

MigrationsGetLargeFilesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsGetLargeFilesRequestOptions

MigrationsGetLargeFilesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/large_files" }

Type declaration

MigrationsGetLargeFilesResponseData

MigrationsGetLargeFilesResponseData: Array<MigrationsGetLargeFilesResponseDataItem>

MigrationsGetLargeFilesResponseDataItem

MigrationsGetLargeFilesResponseDataItem: { oid: string; path: string; ref_name: string; size: number }

Type declaration

  • oid: string
  • path: string
  • ref_name: string
  • size: number

MigrationsGetStatusForAuthenticatedUserEndpoint

MigrationsGetStatusForAuthenticatedUserEndpoint: { migration_id: number }

Type declaration

  • migration_id: number

    migration_id parameter

MigrationsGetStatusForAuthenticatedUserRequestOptions

MigrationsGetStatusForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/migrations/:migration_id" }

Type declaration

MigrationsGetStatusForAuthenticatedUserResponseData

MigrationsGetStatusForAuthenticatedUserResponseData: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsGetStatusForAuthenticatedUserResponseDataOwner; repositories: Array<MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem>; state: string; updated_at: string; url: string }

Type declaration

MigrationsGetStatusForAuthenticatedUserResponseDataOwner

MigrationsGetStatusForAuthenticatedUserResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner; permissions: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner
  • permissions: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsGetStatusForOrgEndpoint

MigrationsGetStatusForOrgEndpoint: { migration_id: number; org: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

MigrationsGetStatusForOrgRequestOptions

MigrationsGetStatusForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id" }

Type declaration

MigrationsGetStatusForOrgResponseData

MigrationsGetStatusForOrgResponseData: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsGetStatusForOrgResponseDataOwner; repositories: Array<MigrationsGetStatusForOrgResponseDataRepositoriesItem>; state: string; updated_at: string; url: string }

Type declaration

MigrationsGetStatusForOrgResponseDataOwner

MigrationsGetStatusForOrgResponseDataOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

MigrationsGetStatusForOrgResponseDataRepositoriesItem

MigrationsGetStatusForOrgResponseDataRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner; permissions: MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner
  • permissions: MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner

MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions

MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsListForAuthenticatedUserEndpoint

MigrationsListForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListForAuthenticatedUserRequestOptions

MigrationsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/migrations" }

Type declaration

MigrationsListForAuthenticatedUserResponseData

MigrationsListForAuthenticatedUserResponseData: Array<MigrationsListForAuthenticatedUserResponseDataItem>

MigrationsListForAuthenticatedUserResponseDataItem

MigrationsListForAuthenticatedUserResponseDataItem: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsListForAuthenticatedUserResponseDataItemOwner; repositories: Array<MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem>; state: string; updated_at: string; url: string }

Type declaration

MigrationsListForAuthenticatedUserResponseDataItemOwner

MigrationsListForAuthenticatedUserResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner; permissions: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner
  • permissions: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsListForOrgEndpoint

MigrationsListForOrgEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListForOrgRequestOptions

MigrationsListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations" }

Type declaration

MigrationsListForOrgResponseData

MigrationsListForOrgResponseData: Array<MigrationsListForOrgResponseDataItem>

MigrationsListForOrgResponseDataItem

MigrationsListForOrgResponseDataItem: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsListForOrgResponseDataItemOwner; repositories: Array<MigrationsListForOrgResponseDataItemRepositoriesItem>; state: string; updated_at: string; url: string }

Type declaration

MigrationsListForOrgResponseDataItemOwner

MigrationsListForOrgResponseDataItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

MigrationsListForOrgResponseDataItemRepositoriesItem

MigrationsListForOrgResponseDataItemRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListForOrgResponseDataItemRepositoriesItemOwner; permissions: MigrationsListForOrgResponseDataItemRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsListForOrgResponseDataItemRepositoriesItemOwner
  • permissions: MigrationsListForOrgResponseDataItemRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsListForOrgResponseDataItemRepositoriesItemOwner

MigrationsListForOrgResponseDataItemRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsListForOrgResponseDataItemRepositoriesItemPermissions

MigrationsListForOrgResponseDataItemRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsListReposForOrgEndpoint

MigrationsListReposForOrgEndpoint: { migration_id: number; org: string; page?: number; per_page?: number }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListReposForOrgRequestOptions

MigrationsListReposForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/repositories" }

Type declaration

MigrationsListReposForOrgResponseData

MigrationsListReposForOrgResponseData: Array<MigrationsListReposForOrgResponseDataItem>

MigrationsListReposForOrgResponseDataItem

MigrationsListReposForOrgResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: MigrationsListReposForOrgResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListReposForOrgResponseDataItemOwner; permissions: MigrationsListReposForOrgResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: MigrationsListReposForOrgResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsListReposForOrgResponseDataItemOwner
  • permissions: MigrationsListReposForOrgResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsListReposForOrgResponseDataItemLicense

MigrationsListReposForOrgResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

MigrationsListReposForOrgResponseDataItemOwner

MigrationsListReposForOrgResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsListReposForOrgResponseDataItemPermissions

MigrationsListReposForOrgResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsListReposForUserEndpoint

MigrationsListReposForUserEndpoint: { migration_id: number; page?: number; per_page?: number }

Type declaration

  • migration_id: number

    migration_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListReposForUserRequestOptions

MigrationsListReposForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/:migration_id/repositories" }

Type declaration

MigrationsListReposForUserResponseData

MigrationsListReposForUserResponseData: Array<MigrationsListReposForUserResponseDataItem>

MigrationsListReposForUserResponseDataItem

MigrationsListReposForUserResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: MigrationsListReposForUserResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListReposForUserResponseDataItemOwner; permissions: MigrationsListReposForUserResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: MigrationsListReposForUserResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsListReposForUserResponseDataItemOwner
  • permissions: MigrationsListReposForUserResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsListReposForUserResponseDataItemLicense

MigrationsListReposForUserResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

MigrationsListReposForUserResponseDataItemOwner

MigrationsListReposForUserResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsListReposForUserResponseDataItemPermissions

MigrationsListReposForUserResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsMapCommitAuthorEndpoint

MigrationsMapCommitAuthorEndpoint: { author_id: number; email?: string; name?: string; owner: string; repo: string }

Type declaration

  • author_id: number

    author_id parameter

  • Optional email?: string

    The new Git author email.

  • Optional name?: string

    The new Git author name.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsMapCommitAuthorRequestOptions

MigrationsMapCommitAuthorRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/authors/:author_id" }

Type declaration

MigrationsMapCommitAuthorResponseData

MigrationsMapCommitAuthorResponseData: { email: string; id: number; import_url: string; name: string; remote_id: string; remote_name: string; url: string }

Type declaration

  • email: string
  • id: number
  • import_url: string
  • name: string
  • remote_id: string
  • remote_name: string
  • url: string

MigrationsSetLfsPreferenceEndpoint

MigrationsSetLfsPreferenceEndpoint: { owner: string; repo: string; use_lfs: "opt_in" | "opt_out" }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • use_lfs: "opt_in" | "opt_out"

    Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).

MigrationsSetLfsPreferenceRequestOptions

MigrationsSetLfsPreferenceRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/lfs" }

Type declaration

MigrationsSetLfsPreferenceResponseData

MigrationsSetLfsPreferenceResponseData: { authors_count: number; authors_url: string; has_large_files: boolean; html_url: string; large_files_count: number; large_files_size: number; repository_url: string; status: string; status_text: string; url: string; use_lfs: string; vcs: string; vcs_url: string }

Type declaration

  • authors_count: number
  • authors_url: string
  • has_large_files: boolean
  • html_url: string
  • large_files_count: number
  • large_files_size: number
  • repository_url: string
  • status: string
  • status_text: string
  • url: string
  • use_lfs: string
  • vcs: string
  • vcs_url: string

MigrationsStartForAuthenticatedUserEndpoint

MigrationsStartForAuthenticatedUserEndpoint: { exclude_attachments?: boolean; lock_repositories?: boolean; repositories: string[] }

Type declaration

  • Optional exclude_attachments?: boolean

    Does not include attachments uploaded to GitHub.com in the migration data when set to true. Excluding attachments will reduce the migration archive file size.

  • Optional lock_repositories?: boolean

    Locks the repositories to prevent changes during the migration when set to true.

  • repositories: string[]

    An array of repositories to include in the migration.

MigrationsStartForAuthenticatedUserRequestOptions

MigrationsStartForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/migrations" }

Type declaration

MigrationsStartForAuthenticatedUserResponseData

MigrationsStartForAuthenticatedUserResponseData: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsStartForAuthenticatedUserResponseDataOwner; repositories: Array<MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem>; state: string; updated_at: string; url: string }

Type declaration

MigrationsStartForAuthenticatedUserResponseDataOwner

MigrationsStartForAuthenticatedUserResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner; permissions: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner
  • permissions: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsStartForOrgEndpoint

MigrationsStartForOrgEndpoint: { exclude_attachments?: boolean; lock_repositories?: boolean; org: string; repositories: string[] }

Type declaration

  • Optional exclude_attachments?: boolean

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

  • Optional lock_repositories?: boolean

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

  • org: string

    org parameter

  • repositories: string[]

    A list of arrays indicating which repositories should be migrated.

MigrationsStartForOrgRequestOptions

MigrationsStartForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/migrations" }

Type declaration

MigrationsStartForOrgResponseData

MigrationsStartForOrgResponseData: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsStartForOrgResponseDataOwner; repositories: Array<MigrationsStartForOrgResponseDataRepositoriesItem>; state: string; updated_at: string; url: string }

Type declaration

MigrationsStartForOrgResponseDataOwner

MigrationsStartForOrgResponseDataOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

MigrationsStartForOrgResponseDataRepositoriesItem

MigrationsStartForOrgResponseDataRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsStartForOrgResponseDataRepositoriesItemOwner; permissions: MigrationsStartForOrgResponseDataRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: MigrationsStartForOrgResponseDataRepositoriesItemOwner
  • permissions: MigrationsStartForOrgResponseDataRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

MigrationsStartForOrgResponseDataRepositoriesItemOwner

MigrationsStartForOrgResponseDataRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

MigrationsStartForOrgResponseDataRepositoriesItemPermissions

MigrationsStartForOrgResponseDataRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

MigrationsStartImportEndpoint

MigrationsStartImportEndpoint: { owner: string; repo: string; tfvc_project?: string; vcs?: "subversion" | "git" | "mercurial" | "tfvc"; vcs_password?: string; vcs_url: string; vcs_username?: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional tfvc_project?: string

    For a tfvc import, the name of the project that is being imported.

  • Optional vcs?: "subversion" | "git" | "mercurial" | "tfvc"

    The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.

  • Optional vcs_password?: string

    If authentication is required, the password to provide to vcs_url.

  • vcs_url: string

    The URL of the originating repository.

  • Optional vcs_username?: string

    If authentication is required, the username to provide to vcs_url.

MigrationsStartImportRequestOptions

MigrationsStartImportRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

MigrationsStartImportResponseData

MigrationsStartImportResponseData: { authors_count: number; authors_url: string; commit_count: number; has_large_files: boolean; html_url: string; large_files_count: number; large_files_size: number; percent: number; repository_url: string; status: string; status_text: string; url: string; use_lfs: string; vcs: string; vcs_url: string }

Type declaration

  • authors_count: number
  • authors_url: string
  • commit_count: number
  • has_large_files: boolean
  • html_url: string
  • large_files_count: number
  • large_files_size: number
  • percent: number
  • repository_url: string
  • status: string
  • status_text: string
  • url: string
  • use_lfs: string
  • vcs: string
  • vcs_url: string

MigrationsUnlockRepoForAuthenticatedUserEndpoint

MigrationsUnlockRepoForAuthenticatedUserEndpoint: { migration_id: number; repo_name: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • repo_name: string

    repo_name parameter

MigrationsUnlockRepoForAuthenticatedUserRequestOptions

MigrationsUnlockRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/migrations/:migration_id/repos/:repo_name/lock" }

Type declaration

MigrationsUnlockRepoForOrgEndpoint

MigrationsUnlockRepoForOrgEndpoint: { migration_id: number; org: string; repo_name: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

  • repo_name: string

    repo_name parameter

MigrationsUnlockRepoForOrgRequestOptions

MigrationsUnlockRepoForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock" }

Type declaration

MigrationsUpdateImportEndpoint

MigrationsUpdateImportEndpoint: { owner: string; repo: string; vcs_password?: string; vcs_username?: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional vcs_password?: string

    The password to provide to the originating repository.

  • Optional vcs_username?: string

    The username to provide to the originating repository.

MigrationsUpdateImportRequestOptions

MigrationsUpdateImportRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

MigrationsUpdateImportResponseData

MigrationsUpdateImportResponseData: { authors_count?: number; authors_url: string; commit_count?: number; has_large_files?: boolean; html_url: string; large_files_count?: number; large_files_size?: number; percent?: number; repository_url: string; status: string; status_text?: string; tfvc_project?: string; url: string; use_lfs: string; vcs: string; vcs_url: string }

Type declaration

  • Optional authors_count?: number
  • authors_url: string
  • Optional commit_count?: number
  • Optional has_large_files?: boolean
  • html_url: string
  • Optional large_files_count?: number
  • Optional large_files_size?: number
  • Optional percent?: number
  • repository_url: string
  • status: string
  • Optional status_text?: string
  • Optional tfvc_project?: string
  • url: string
  • use_lfs: string
  • vcs: string
  • vcs_url: string

OauthAuthorizationsCreateAuthorizationEndpoint

OauthAuthorizationsCreateAuthorizationEndpoint: { client_id?: string; client_secret?: string; fingerprint?: string; note: string; note_url?: string; scopes?: string[] }

Type declaration

  • Optional client_id?: string

    The 20 character OAuth app client key for which to create the token.

  • Optional client_secret?: string

    The 40 character OAuth app client secret for which to create the token.

  • Optional fingerprint?: string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • note: string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsCreateAuthorizationRequestOptions

OauthAuthorizationsCreateAuthorizationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/authorizations" }

Type declaration

OauthAuthorizationsCreateAuthorizationResponseData

OauthAuthorizationsCreateAuthorizationResponseData: { app: OauthAuthorizationsCreateAuthorizationResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

Type declaration

OauthAuthorizationsCreateAuthorizationResponseDataApp

OauthAuthorizationsCreateAuthorizationResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OauthAuthorizationsDeleteAuthorizationEndpoint

OauthAuthorizationsDeleteAuthorizationEndpoint: { authorization_id: number }

Type declaration

  • authorization_id: number

    authorization_id parameter

OauthAuthorizationsDeleteAuthorizationRequestOptions

OauthAuthorizationsDeleteAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/authorizations/:authorization_id" }

Type declaration

OauthAuthorizationsDeleteGrantEndpoint

OauthAuthorizationsDeleteGrantEndpoint: { grant_id: number }

Type declaration

  • grant_id: number

    grant_id parameter

OauthAuthorizationsDeleteGrantRequestOptions

OauthAuthorizationsDeleteGrantRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/grants/:grant_id" }

Type declaration

OauthAuthorizationsGetAuthorizationEndpoint

OauthAuthorizationsGetAuthorizationEndpoint: { authorization_id: number }

Type declaration

  • authorization_id: number

    authorization_id parameter

OauthAuthorizationsGetAuthorizationRequestOptions

OauthAuthorizationsGetAuthorizationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/authorizations/:authorization_id" }

Type declaration

OauthAuthorizationsGetAuthorizationResponseData

OauthAuthorizationsGetAuthorizationResponseData: { app: OauthAuthorizationsGetAuthorizationResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

Type declaration

  • app: OauthAuthorizationsGetAuthorizationResponseDataApp
  • created_at: string
  • fingerprint: string
  • hashed_token: string
  • id: number
  • note: string
  • note_url: string
  • scopes: Array<string>
  • token: string
  • token_last_eight: string
  • updated_at: string
  • url: string

OauthAuthorizationsGetAuthorizationResponseDataApp

OauthAuthorizationsGetAuthorizationResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OauthAuthorizationsGetGrantEndpoint

OauthAuthorizationsGetGrantEndpoint: { grant_id: number }

Type declaration

  • grant_id: number

    grant_id parameter

OauthAuthorizationsGetGrantRequestOptions

OauthAuthorizationsGetGrantRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/applications/grants/:grant_id" }

Type declaration

OauthAuthorizationsGetGrantResponseData

OauthAuthorizationsGetGrantResponseData: { app: OauthAuthorizationsGetGrantResponseDataApp; created_at: string; id: number; scopes: Array<string>; updated_at: string; url: string }

Type declaration

OauthAuthorizationsGetGrantResponseDataApp

OauthAuthorizationsGetGrantResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint: { client_id: string; client_secret: string; fingerprint: string; note?: string; note_url?: string; scopes?: string[] }

Type declaration

  • client_id: string

    client_id parameter

  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • fingerprint: string

    fingerprint parameter

  • Optional note?: string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/authorizations/clients/:client_id/:fingerprint" }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData: { app: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint: { client_id: string; client_secret: string; fingerprint?: string; note?: string; note_url?: string; scopes?: string[] }

Type declaration

  • client_id: string

    client_id parameter

  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • Optional fingerprint?: string

    A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to Get-or-create an authorization for a specific app and fingerprint.

  • Optional note?: string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/authorizations/clients/:client_id" }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData: { app: OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OauthAuthorizationsListAuthorizationsEndpoint

OauthAuthorizationsListAuthorizationsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OauthAuthorizationsListAuthorizationsRequestOptions

OauthAuthorizationsListAuthorizationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/authorizations" }

Type declaration

OauthAuthorizationsListAuthorizationsResponseData

OauthAuthorizationsListAuthorizationsResponseData: Array<OauthAuthorizationsListAuthorizationsResponseDataItem>

OauthAuthorizationsListAuthorizationsResponseDataItem

OauthAuthorizationsListAuthorizationsResponseDataItem: { app: OauthAuthorizationsListAuthorizationsResponseDataItemApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

Type declaration

OauthAuthorizationsListAuthorizationsResponseDataItemApp

OauthAuthorizationsListAuthorizationsResponseDataItemApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OauthAuthorizationsListGrantsEndpoint

OauthAuthorizationsListGrantsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OauthAuthorizationsListGrantsRequestOptions

OauthAuthorizationsListGrantsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/applications/grants" }

Type declaration

OauthAuthorizationsListGrantsResponseData

OauthAuthorizationsListGrantsResponseData: Array<OauthAuthorizationsListGrantsResponseDataItem>

OauthAuthorizationsListGrantsResponseDataItem

OauthAuthorizationsListGrantsResponseDataItem: { app: OauthAuthorizationsListGrantsResponseDataItemApp; created_at: string; id: number; scopes: Array<string>; updated_at: string; url: string }

Type declaration

OauthAuthorizationsListGrantsResponseDataItemApp

OauthAuthorizationsListGrantsResponseDataItemApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OauthAuthorizationsUpdateAuthorizationEndpoint

OauthAuthorizationsUpdateAuthorizationEndpoint: { add_scopes?: string[]; authorization_id: number; fingerprint?: string; note?: string; note_url?: string; remove_scopes?: string[]; scopes?: string[] }

Type declaration

  • Optional add_scopes?: string[]

    A list of scopes to add to this authorization.

  • authorization_id: number

    authorization_id parameter

  • Optional fingerprint?: string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • Optional note?: string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional remove_scopes?: string[]

    A list of scopes to remove from this authorization.

  • Optional scopes?: string[]

    Replaces the authorization scopes with these.

OauthAuthorizationsUpdateAuthorizationRequestOptions

OauthAuthorizationsUpdateAuthorizationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/authorizations/:authorization_id" }

Type declaration

OauthAuthorizationsUpdateAuthorizationResponseData

OauthAuthorizationsUpdateAuthorizationResponseData: { app: OauthAuthorizationsUpdateAuthorizationResponseDataApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

Type declaration

OauthAuthorizationsUpdateAuthorizationResponseDataApp

OauthAuthorizationsUpdateAuthorizationResponseDataApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

OrgsAddOrUpdateMembershipEndpoint

OrgsAddOrUpdateMembershipEndpoint: { org: string; role?: "admin" | "member"; username: string }

Type declaration

  • org: string

    org parameter

  • Optional role?: "admin" | "member"

    The role to give the user in the organization. Can be one of: * admin - The user will become an owner of the organization. * member - The user will become a non-owner member of the organization.

  • username: string

    username parameter

OrgsAddOrUpdateMembershipRequestOptions

OrgsAddOrUpdateMembershipRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/memberships/:username" }

Type declaration

OrgsAddOrUpdateMembershipResponseData

OrgsAddOrUpdateMembershipResponseData: { organization: OrgsAddOrUpdateMembershipResponseDataOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsAddOrUpdateMembershipResponseDataUser }

Type declaration

OrgsAddOrUpdateMembershipResponseDataOrganization

OrgsAddOrUpdateMembershipResponseDataOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsAddOrUpdateMembershipResponseDataUser

OrgsAddOrUpdateMembershipResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsBlockUserEndpoint

OrgsBlockUserEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsBlockUserRequestOptions

OrgsBlockUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/blocks/:username" }

Type declaration

OrgsCheckBlockedUserEndpoint

OrgsCheckBlockedUserEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsCheckBlockedUserRequestOptions

OrgsCheckBlockedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/blocks/:username" }

Type declaration

OrgsCheckMembershipEndpoint

OrgsCheckMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsCheckMembershipRequestOptions

OrgsCheckMembershipRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/members/:username" }

Type declaration

OrgsCheckPublicMembershipEndpoint

OrgsCheckPublicMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsCheckPublicMembershipRequestOptions

OrgsCheckPublicMembershipRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/public_members/:username" }

Type declaration

OrgsConcealMembershipEndpoint

OrgsConcealMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsConcealMembershipRequestOptions

OrgsConcealMembershipRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/public_members/:username" }

Type declaration

OrgsConvertMemberToOutsideCollaboratorEndpoint

OrgsConvertMemberToOutsideCollaboratorEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsConvertMemberToOutsideCollaboratorRequestOptions

OrgsConvertMemberToOutsideCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/outside_collaborators/:username" }

Type declaration

OrgsConvertMemberToOutsideCollaboratorResponseData

OrgsConvertMemberToOutsideCollaboratorResponseData: { documentation_url: string; message: string }

Type declaration

  • documentation_url: string
  • message: string

OrgsCreateHookEndpoint

OrgsCreateHookEndpoint: { active?: boolean; config: OrgsCreateHookParamsConfig; events?: string[]; name: string; org: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: OrgsCreateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • name: string

    Must be passed as "web".

  • org: string

    org parameter

OrgsCreateHookParamsConfig

OrgsCreateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

OrgsCreateHookRequestOptions

OrgsCreateHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/hooks" }

Type declaration

OrgsCreateHookResponseData

OrgsCreateHookResponseData: { active: boolean; config: OrgsCreateHookResponseDataConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

Type declaration

  • active: boolean
  • config: OrgsCreateHookResponseDataConfig
  • created_at: string
  • events: Array<string>
  • id: number
  • name: string
  • ping_url: string
  • updated_at: string
  • url: string

OrgsCreateHookResponseDataConfig

OrgsCreateHookResponseDataConfig: { content_type: string; url: string }

Type declaration

  • content_type: string
  • url: string

OrgsCreateInvitationEndpoint

OrgsCreateInvitationEndpoint: { email?: string; invitee_id?: number; org: string; role?: "admin" | "direct_member" | "billing_manager"; team_ids?: number[] }

Type declaration

  • Optional email?: string

    Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

  • Optional invitee_id?: number

    Required unless you provide email. GitHub user ID for the person you are inviting.

  • org: string

    org parameter

  • Optional role?: "admin" | "direct_member" | "billing_manager"

    Specify role for new member. Can be one of: * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * direct_member - Non-owner organization members with ability to see other members and join teams by invitation. * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.

  • Optional team_ids?: number[]

    Specify IDs for the teams you want to invite new members to.

OrgsCreateInvitationRequestOptions

OrgsCreateInvitationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/invitations" }

Type declaration

OrgsCreateInvitationResponseData

OrgsCreateInvitationResponseData: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: OrgsCreateInvitationResponseDataInviter; login: string; role: string; team_count: number }

Type declaration

OrgsCreateInvitationResponseDataInviter

OrgsCreateInvitationResponseDataInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsDeleteHookEndpoint

OrgsDeleteHookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsDeleteHookRequestOptions

OrgsDeleteHookRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id" }

Type declaration

OrgsGetEndpoint

OrgsGetEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsGetHookEndpoint

OrgsGetHookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsGetHookRequestOptions

OrgsGetHookRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id" }

Type declaration

OrgsGetHookResponseData

OrgsGetHookResponseData: { active: boolean; config: OrgsGetHookResponseDataConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

Type declaration

  • active: boolean
  • config: OrgsGetHookResponseDataConfig
  • created_at: string
  • events: Array<string>
  • id: number
  • name: string
  • ping_url: string
  • updated_at: string
  • url: string

OrgsGetHookResponseDataConfig

OrgsGetHookResponseDataConfig: { content_type: string; url: string }

Type declaration

  • content_type: string
  • url: string

OrgsGetMembershipEndpoint

OrgsGetMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsGetMembershipForAuthenticatedUserEndpoint

OrgsGetMembershipForAuthenticatedUserEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsGetMembershipForAuthenticatedUserRequestOptions

OrgsGetMembershipForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/memberships/orgs/:org" }

Type declaration

OrgsGetMembershipForAuthenticatedUserResponseData

OrgsGetMembershipForAuthenticatedUserResponseData: { organization: OrgsGetMembershipForAuthenticatedUserResponseDataOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsGetMembershipForAuthenticatedUserResponseDataUser }

Type declaration

OrgsGetMembershipForAuthenticatedUserResponseDataOrganization

OrgsGetMembershipForAuthenticatedUserResponseDataOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsGetMembershipForAuthenticatedUserResponseDataUser

OrgsGetMembershipForAuthenticatedUserResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsGetMembershipRequestOptions

OrgsGetMembershipRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/memberships/:username" }

Type declaration

OrgsGetMembershipResponseData

OrgsGetMembershipResponseData: { organization: OrgsGetMembershipResponseDataOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsGetMembershipResponseDataUser }

Type declaration

OrgsGetMembershipResponseDataOrganization

OrgsGetMembershipResponseDataOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsGetMembershipResponseDataUser

OrgsGetMembershipResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsGetRequestOptions

OrgsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org" }

Type declaration

OrgsGetResponseData

OrgsGetResponseData: { avatar_url: string; billing_email?: string; blog: string; collaborators?: number; company: string; created_at: string; default_repository_permission?: string; description: string; disk_usage?: number; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_allowed_repository_creation_type?: string; members_can_create_internal_repositories?: boolean; members_can_create_private_repositories?: boolean; members_can_create_public_repositories?: boolean; members_can_create_repositories?: boolean; members_url: string; name: string; node_id: string; owned_private_repos?: number; plan: OrgsGetResponseDataPlan; private_gists?: number; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; total_private_repos?: number; two_factor_requirement_enabled?: boolean; type: string; url: string }

Type declaration

  • avatar_url: string
  • Optional billing_email?: string
  • blog: string
  • Optional collaborators?: number
  • company: string
  • created_at: string
  • Optional default_repository_permission?: string
  • description: string
  • Optional disk_usage?: number
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • Optional members_allowed_repository_creation_type?: string
  • Optional members_can_create_internal_repositories?: boolean
  • Optional members_can_create_private_repositories?: boolean
  • Optional members_can_create_public_repositories?: boolean
  • Optional members_can_create_repositories?: boolean
  • members_url: string
  • name: string
  • node_id: string
  • Optional owned_private_repos?: number
  • plan: OrgsGetResponseDataPlan
  • Optional private_gists?: number
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • Optional total_private_repos?: number
  • Optional two_factor_requirement_enabled?: boolean
  • type: string
  • url: string

OrgsGetResponseDataPlan

OrgsGetResponseDataPlan: { filled_seats?: number; name: string; private_repos: number; seats?: number; space: number }

Type declaration

  • Optional filled_seats?: number
  • name: string
  • private_repos: number
  • Optional seats?: number
  • space: number

OrgsListBlockedUsersEndpoint

OrgsListBlockedUsersEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsListBlockedUsersRequestOptions

OrgsListBlockedUsersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/blocks" }

Type declaration

OrgsListBlockedUsersResponseData

OrgsListBlockedUsersResponseData: Array<OrgsListBlockedUsersResponseDataItem>

OrgsListBlockedUsersResponseDataItem

OrgsListBlockedUsersResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsListCredentialAuthorizationsEndpoint

OrgsListCredentialAuthorizationsEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsListCredentialAuthorizationsRequestOptions

OrgsListCredentialAuthorizationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/credential-authorizations" }

Type declaration

OrgsListCredentialAuthorizationsResponseData

OrgsListCredentialAuthorizationsResponseData: Array<OrgsListCredentialAuthorizationsResponseDataItem>

OrgsListCredentialAuthorizationsResponseDataItem

OrgsListCredentialAuthorizationsResponseDataItem: { credential_authorized_at: string; credential_id: string; credential_type: string; login: string; scopes: Array<string>; token_last_eight: string }

Type declaration

  • credential_authorized_at: string
  • credential_id: string
  • credential_type: string
  • login: string
  • scopes: Array<string>
  • token_last_eight: string

OrgsListEndpoint

OrgsListEndpoint: { page?: number; per_page?: number; since?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: number

    The integer ID of the last organization that you've seen.

OrgsListForAuthenticatedUserEndpoint

OrgsListForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListForAuthenticatedUserRequestOptions

OrgsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/orgs" }

Type declaration

OrgsListForAuthenticatedUserResponseData

OrgsListForAuthenticatedUserResponseData: Array<OrgsListForAuthenticatedUserResponseDataItem>

OrgsListForAuthenticatedUserResponseDataItem

OrgsListForAuthenticatedUserResponseDataItem: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsListForUserEndpoint

OrgsListForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

OrgsListForUserRequestOptions

OrgsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/orgs" }

Type declaration

OrgsListForUserResponseData

OrgsListForUserResponseData: Array<OrgsListForUserResponseDataItem>

OrgsListForUserResponseDataItem

OrgsListForUserResponseDataItem: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsListHooksEndpoint

OrgsListHooksEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListHooksRequestOptions

OrgsListHooksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/hooks" }

Type declaration

OrgsListHooksResponseData

OrgsListHooksResponseData: Array<OrgsListHooksResponseDataItem>

OrgsListHooksResponseDataItem

OrgsListHooksResponseDataItem: { active: boolean; config: OrgsListHooksResponseDataItemConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

Type declaration

OrgsListHooksResponseDataItemConfig

OrgsListHooksResponseDataItemConfig: { content_type: string; url: string }

Type declaration

  • content_type: string
  • url: string

OrgsListInstallationsEndpoint

OrgsListInstallationsEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListInstallationsRequestOptions

OrgsListInstallationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/installations" }

Type declaration

OrgsListInstallationsResponseData

OrgsListInstallationsResponseData: { installations: Array<OrgsListInstallationsResponseDataInstallationsItem>; total_count: number }

Type declaration

OrgsListInstallationsResponseDataInstallationsItem

OrgsListInstallationsResponseDataInstallationsItem: { access_tokens_url: string; account: OrgsListInstallationsResponseDataInstallationsItemAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: OrgsListInstallationsResponseDataInstallationsItemPermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

Type declaration

OrgsListInstallationsResponseDataInstallationsItemAccount

OrgsListInstallationsResponseDataInstallationsItemAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsListInstallationsResponseDataInstallationsItemPermissions

OrgsListInstallationsResponseDataInstallationsItemPermissions: { deployments: string; metadata: string; pull_requests: string; statuses: string }

Type declaration

  • deployments: string
  • metadata: string
  • pull_requests: string
  • statuses: string

OrgsListInvitationTeamsEndpoint

OrgsListInvitationTeamsEndpoint: { invitation_id: number; org: string; page?: number; per_page?: number }

Type declaration

  • invitation_id: number

    invitation_id parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListInvitationTeamsRequestOptions

OrgsListInvitationTeamsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/invitations/:invitation_id/teams" }

Type declaration

OrgsListInvitationTeamsResponseData

OrgsListInvitationTeamsResponseData: Array<OrgsListInvitationTeamsResponseDataItem>

OrgsListInvitationTeamsResponseDataItem

OrgsListInvitationTeamsResponseDataItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

OrgsListMembersEndpoint

OrgsListMembersEndpoint: { filter?: "2fa_disabled" | "all"; org: string; page?: number; per_page?: number; role?: "all" | "admin" | "member" }

Type declaration

  • Optional filter?: "2fa_disabled" | "all"

    Filter members returned in the list. Can be one of: * 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners. * all - All members the authenticated user can see.

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional role?: "all" | "admin" | "member"

    Filter members returned by their role. Can be one of: * all - All members of the organization, regardless of role. * admin - Organization owners. * member - Non-owner organization members.

OrgsListMembersRequestOptions

OrgsListMembersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/members" }

Type declaration

OrgsListMembersResponseData

OrgsListMembersResponseData: Array<OrgsListMembersResponseDataItem>

OrgsListMembersResponseDataItem

OrgsListMembersResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsListMembershipsEndpoint

OrgsListMembershipsEndpoint: { page?: number; per_page?: number; state?: "active" | "pending" }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional state?: "active" | "pending"

    Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.

OrgsListMembershipsRequestOptions

OrgsListMembershipsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/memberships/orgs" }

Type declaration

OrgsListMembershipsResponseData

OrgsListMembershipsResponseData: Array<OrgsListMembershipsResponseDataItem>

OrgsListMembershipsResponseDataItem

OrgsListMembershipsResponseDataItem: { organization: OrgsListMembershipsResponseDataItemOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsListMembershipsResponseDataItemUser }

Type declaration

OrgsListMembershipsResponseDataItemOrganization

OrgsListMembershipsResponseDataItemOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsListMembershipsResponseDataItemUser

OrgsListMembershipsResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsListOutsideCollaboratorsEndpoint

OrgsListOutsideCollaboratorsEndpoint: { filter?: "2fa_disabled" | "all"; org: string; page?: number; per_page?: number }

Type declaration

  • Optional filter?: "2fa_disabled" | "all"

    Filter the list of outside collaborators. Can be one of: * 2fa_disabled: Outside collaborators without two-factor authentication enabled. * all: All outside collaborators.

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListOutsideCollaboratorsRequestOptions

OrgsListOutsideCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/outside_collaborators" }

Type declaration

OrgsListOutsideCollaboratorsResponseData

OrgsListOutsideCollaboratorsResponseData: Array<OrgsListOutsideCollaboratorsResponseDataItem>

OrgsListOutsideCollaboratorsResponseDataItem

OrgsListOutsideCollaboratorsResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsListPendingInvitationsEndpoint

OrgsListPendingInvitationsEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListPendingInvitationsRequestOptions

OrgsListPendingInvitationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/invitations" }

Type declaration

OrgsListPendingInvitationsResponseData

OrgsListPendingInvitationsResponseData: Array<OrgsListPendingInvitationsResponseDataItem>

OrgsListPendingInvitationsResponseDataItem

OrgsListPendingInvitationsResponseDataItem: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: OrgsListPendingInvitationsResponseDataItemInviter; login: string; role: string; team_count: number }

Type declaration

OrgsListPendingInvitationsResponseDataItemInviter

OrgsListPendingInvitationsResponseDataItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsListPublicMembersEndpoint

OrgsListPublicMembersEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListPublicMembersRequestOptions

OrgsListPublicMembersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/public_members" }

Type declaration

OrgsListPublicMembersResponseData

OrgsListPublicMembersResponseData: Array<OrgsListPublicMembersResponseDataItem>

OrgsListPublicMembersResponseDataItem

OrgsListPublicMembersResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsListRequestOptions

OrgsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/organizations" }

Type declaration

OrgsListResponseData

OrgsListResponseData: Array<OrgsListResponseDataItem>

OrgsListResponseDataItem

OrgsListResponseDataItem: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsPingHookEndpoint

OrgsPingHookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsPingHookRequestOptions

OrgsPingHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id/pings" }

Type declaration

OrgsPublicizeMembershipEndpoint

OrgsPublicizeMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsPublicizeMembershipRequestOptions

OrgsPublicizeMembershipRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/public_members/:username" }

Type declaration

OrgsRemoveCredentialAuthorizationEndpoint

OrgsRemoveCredentialAuthorizationEndpoint: { credential_id: number; org: string }

Type declaration

  • credential_id: number

    credential_id parameter

  • org: string

    org parameter

OrgsRemoveCredentialAuthorizationRequestOptions

OrgsRemoveCredentialAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/credential-authorizations/:credential_id" }

Type declaration

OrgsRemoveMemberEndpoint

OrgsRemoveMemberEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsRemoveMemberRequestOptions

OrgsRemoveMemberRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/members/:username" }

Type declaration

OrgsRemoveMembershipEndpoint

OrgsRemoveMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsRemoveMembershipRequestOptions

OrgsRemoveMembershipRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/memberships/:username" }

Type declaration

OrgsRemoveOutsideCollaboratorEndpoint

OrgsRemoveOutsideCollaboratorEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsRemoveOutsideCollaboratorRequestOptions

OrgsRemoveOutsideCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/outside_collaborators/:username" }

Type declaration

OrgsRemoveOutsideCollaboratorResponseData

OrgsRemoveOutsideCollaboratorResponseData: { documentation_url: string; message: string }

Type declaration

  • documentation_url: string
  • message: string

OrgsUnblockUserEndpoint

OrgsUnblockUserEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsUnblockUserRequestOptions

OrgsUnblockUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/blocks/:username" }

Type declaration

OrgsUpdateEndpoint

OrgsUpdateEndpoint: { billing_email?: string; company?: string; default_repository_permission?: "read" | "write" | "admin" | "none"; description?: string; email?: string; has_organization_projects?: boolean; has_repository_projects?: boolean; location?: string; members_allowed_repository_creation_type?: "all" | "private" | "none"; members_can_create_internal_repositories?: boolean; members_can_create_private_repositories?: boolean; members_can_create_public_repositories?: boolean; members_can_create_repositories?: boolean; name?: string; org: string }

Type declaration

  • Optional billing_email?: string

    Billing email address. This address is not publicized.

  • Optional company?: string

    The company name.

  • Optional default_repository_permission?: "read" | "write" | "admin" | "none"

    Default permission level members have for organization repositories: * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default.

  • Optional description?: string

    The description of the company.

  • Optional email?: string

    The publicly visible email address.

  • Optional has_organization_projects?: boolean

    Toggles whether an organization can use organization projects.

  • Optional has_repository_projects?: boolean

    Toggles whether repositories that belong to the organization can use repository projects.

  • Optional location?: string

    The location.

  • Optional members_allowed_repository_creation_type?: "all" | "private" | "none"

    Specifies which types of repositories non-admin organization members can create. Can be one of: * all - all organization members can create public and private repositories. * private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. * none - only admin members can create repositories. Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See this note for details.

  • Optional members_can_create_internal_repositories?: boolean

    Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * true - all organization members can create internal repositories. * false - only organization owners can create internal repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

  • Optional members_can_create_private_repositories?: boolean

    Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * true - all organization members can create private repositories. * false - only organization owners can create private repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

  • Optional members_can_create_public_repositories?: boolean

    Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * true - all organization members can create public repositories. * false - only organization owners can create public repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

  • Optional members_can_create_repositories?: boolean

    Toggles the ability of non-admin organization members to create repositories. Can be one of: * true - all organization members can create repositories. * false - only organization owners can create repositories. Default: true Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

  • Optional name?: string

    The shorthand name of the company.

  • org: string

    org parameter

OrgsUpdateHookEndpoint

OrgsUpdateHookEndpoint: { active?: boolean; config?: OrgsUpdateHookParamsConfig; events?: string[]; hook_id: number; org: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional config?: OrgsUpdateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsUpdateHookParamsConfig

OrgsUpdateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

OrgsUpdateHookRequestOptions

OrgsUpdateHookRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id" }

Type declaration

OrgsUpdateHookResponseData

OrgsUpdateHookResponseData: { active: boolean; config: OrgsUpdateHookResponseDataConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

Type declaration

  • active: boolean
  • config: OrgsUpdateHookResponseDataConfig
  • created_at: string
  • events: Array<string>
  • id: number
  • name: string
  • ping_url: string
  • updated_at: string
  • url: string

OrgsUpdateHookResponseDataConfig

OrgsUpdateHookResponseDataConfig: { content_type: string; url: string }

Type declaration

  • content_type: string
  • url: string

OrgsUpdateMembershipEndpoint

OrgsUpdateMembershipEndpoint: { org: string; state: "active" }

Type declaration

  • org: string

    org parameter

  • state: "active"

    The state that the membership should be in. Only "active" will be accepted.

OrgsUpdateMembershipRequestOptions

OrgsUpdateMembershipRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user/memberships/orgs/:org" }

Type declaration

OrgsUpdateMembershipResponseData

OrgsUpdateMembershipResponseData: { organization: OrgsUpdateMembershipResponseDataOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsUpdateMembershipResponseDataUser }

Type declaration

OrgsUpdateMembershipResponseDataOrganization

OrgsUpdateMembershipResponseDataOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

OrgsUpdateMembershipResponseDataUser

OrgsUpdateMembershipResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

OrgsUpdateRequestOptions

OrgsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org" }

Type declaration

OrgsUpdateResponseData

OrgsUpdateResponseData: { avatar_url: string; billing_email: string; blog: string; collaborators: number; company: string; created_at: string; default_repository_permission: string; description: string; disk_usage: number; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_allowed_repository_creation_type: string; members_can_create_internal_repositories: boolean; members_can_create_private_repositories: boolean; members_can_create_public_repositories: boolean; members_can_create_repositories: boolean; members_url: string; name: string; node_id: string; owned_private_repos: number; plan: OrgsUpdateResponseDataPlan; private_gists: number; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; total_private_repos: number; two_factor_requirement_enabled: boolean; type: string; url: string }

Type declaration

  • avatar_url: string
  • billing_email: string
  • blog: string
  • collaborators: number
  • company: string
  • created_at: string
  • default_repository_permission: string
  • description: string
  • disk_usage: number
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • members_allowed_repository_creation_type: string
  • members_can_create_internal_repositories: boolean
  • members_can_create_private_repositories: boolean
  • members_can_create_public_repositories: boolean
  • members_can_create_repositories: boolean
  • members_url: string
  • name: string
  • node_id: string
  • owned_private_repos: number
  • plan: OrgsUpdateResponseDataPlan
  • private_gists: number
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • total_private_repos: number
  • two_factor_requirement_enabled: boolean
  • type: string
  • url: string

OrgsUpdateResponseDataPlan

OrgsUpdateResponseDataPlan: { name: string; private_repos: number; space: number }

Type declaration

  • name: string
  • private_repos: number
  • space: number

ProjectsAddCollaboratorEndpoint

ProjectsAddCollaboratorEndpoint: { permission?: "read" | "write" | "admin"; project_id: number; username: string }

Type declaration

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." Can be one of: * read - can read, but not write to or administer this project. * write - can read and write, but not administer this project. * admin - can read, write and administer this project.

  • project_id: number

    project_id parameter

  • username: string

    username parameter

ProjectsAddCollaboratorRequestOptions

ProjectsAddCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators/:username" }

Type declaration

ProjectsCreateCardEndpoint

ProjectsCreateCardEndpoint: { column_id: number; content_id?: number; content_type?: string; note?: string }

Type declaration

  • column_id: number

    column_id parameter

  • Optional content_id?: number

    The issue or pull request id you want to associate with this card. You can use the List repository issues and List pull requests endpoints to find this id. Note: Depending on whether you use the issue id or pull request id, you will need to specify Issue or PullRequest as the content_type.

  • Optional content_type?: string

    Required if you provide content_id. The type of content you want to associate with this card. Use Issue when content_id is an issue id and use PullRequest when content_id is a pull request id.

  • Optional note?: string

    The card's note content. Only valid for cards without another type of content, so you must omit when specifying content_id and content_type.

ProjectsCreateCardRequestOptions

ProjectsCreateCardRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/columns/:column_id/cards" }

Type declaration

ProjectsCreateCardResponseData

ProjectsCreateCardResponseData: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsCreateCardResponseDataCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsCreateCardResponseDataCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsCreateCardResponseDataCreator

ProjectsCreateCardResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsCreateColumnEndpoint

ProjectsCreateColumnEndpoint: { name: string; project_id: number }

Type declaration

  • name: string

    The name of the column.

  • project_id: number

    project_id parameter

ProjectsCreateColumnRequestOptions

ProjectsCreateColumnRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/:project_id/columns" }

Type declaration

ProjectsCreateColumnResponseData

ProjectsCreateColumnResponseData: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsCreateForAuthenticatedUserEndpoint

ProjectsCreateForAuthenticatedUserEndpoint: { body?: string; name: string }

Type declaration

  • Optional body?: string

    The description of the project.

  • name: string

    The name of the project.

ProjectsCreateForAuthenticatedUserRequestOptions

ProjectsCreateForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/projects" }

Type declaration

ProjectsCreateForAuthenticatedUserResponseData

ProjectsCreateForAuthenticatedUserResponseData: { body: string; columns_url: string; created_at: string; creator: ProjectsCreateForAuthenticatedUserResponseDataCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

ProjectsCreateForAuthenticatedUserResponseDataCreator

ProjectsCreateForAuthenticatedUserResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsCreateForOrgEndpoint

ProjectsCreateForOrgEndpoint: { body?: string; name: string; org: string }

Type declaration

  • Optional body?: string

    The description of the project.

  • name: string

    The name of the project.

  • org: string

    org parameter

ProjectsCreateForOrgRequestOptions

ProjectsCreateForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/projects" }

Type declaration

ProjectsCreateForOrgResponseData

ProjectsCreateForOrgResponseData: { body: string; columns_url: string; created_at: string; creator: ProjectsCreateForOrgResponseDataCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsCreateForOrgResponseDataCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsCreateForOrgResponseDataCreator

ProjectsCreateForOrgResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsCreateForRepoEndpoint

ProjectsCreateForRepoEndpoint: { body?: string; name: string; owner: string; repo: string }

Type declaration

  • Optional body?: string

    The description of the project.

  • name: string

    The name of the project.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ProjectsCreateForRepoRequestOptions

ProjectsCreateForRepoRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/projects" }

Type declaration

ProjectsCreateForRepoResponseData

ProjectsCreateForRepoResponseData: { body: string; columns_url: string; created_at: string; creator: ProjectsCreateForRepoResponseDataCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsCreateForRepoResponseDataCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsCreateForRepoResponseDataCreator

ProjectsCreateForRepoResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsDeleteCardEndpoint

ProjectsDeleteCardEndpoint: { card_id: number }

Type declaration

  • card_id: number

    card_id parameter

ProjectsDeleteCardRequestOptions

ProjectsDeleteCardRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id" }

Type declaration

ProjectsDeleteColumnEndpoint

ProjectsDeleteColumnEndpoint: { column_id: number }

Type declaration

  • column_id: number

    column_id parameter

ProjectsDeleteColumnRequestOptions

ProjectsDeleteColumnRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/columns/:column_id" }

Type declaration

ProjectsDeleteEndpoint

ProjectsDeleteEndpoint: { project_id: number }

Type declaration

  • project_id: number

    project_id parameter

ProjectsDeleteRequestOptions

ProjectsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/:project_id" }

Type declaration

ProjectsGetCardEndpoint

ProjectsGetCardEndpoint: { card_id: number }

Type declaration

  • card_id: number

    card_id parameter

ProjectsGetCardRequestOptions

ProjectsGetCardRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id" }

Type declaration

ProjectsGetCardResponseData

ProjectsGetCardResponseData: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsGetCardResponseDataCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsGetCardResponseDataCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsGetCardResponseDataCreator

ProjectsGetCardResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsGetColumnEndpoint

ProjectsGetColumnEndpoint: { column_id: number }

Type declaration

  • column_id: number

    column_id parameter

ProjectsGetColumnRequestOptions

ProjectsGetColumnRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/columns/:column_id" }

Type declaration

ProjectsGetColumnResponseData

ProjectsGetColumnResponseData: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsGetEndpoint

ProjectsGetEndpoint: { project_id: number }

Type declaration

  • project_id: number

    project_id parameter

ProjectsGetRequestOptions

ProjectsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id" }

Type declaration

ProjectsGetResponseData

ProjectsGetResponseData: { body: string; columns_url: string; created_at: string; creator: ProjectsGetResponseDataCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsGetResponseDataCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsGetResponseDataCreator

ProjectsGetResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsListCardsEndpoint

ProjectsListCardsEndpoint: { archived_state?: "all" | "archived" | "not_archived"; column_id: number; page?: number; per_page?: number }

Type declaration

  • Optional archived_state?: "all" | "archived" | "not_archived"

    Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.

  • column_id: number

    column_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ProjectsListCardsRequestOptions

ProjectsListCardsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/columns/:column_id/cards" }

Type declaration

ProjectsListCardsResponseData

ProjectsListCardsResponseData: Array<ProjectsListCardsResponseDataItem>

ProjectsListCardsResponseDataItem

ProjectsListCardsResponseDataItem: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsListCardsResponseDataItemCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsListCardsResponseDataItemCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsListCardsResponseDataItemCreator

ProjectsListCardsResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsListCollaboratorsEndpoint

ProjectsListCollaboratorsEndpoint: { affiliation?: "outside" | "direct" | "all"; page?: number; per_page?: number; project_id: number }

Type declaration

  • Optional affiliation?: "outside" | "direct" | "all"

    Filters the collaborators by their affiliation. Can be one of: * outside: Outside collaborators of a project that are not a member of the project's organization. * direct: Collaborators with permissions to a project, regardless of organization membership status. * all: All collaborators the authenticated user can see.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • project_id: number

    project_id parameter

ProjectsListCollaboratorsRequestOptions

ProjectsListCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators" }

Type declaration

ProjectsListCollaboratorsResponseData

ProjectsListCollaboratorsResponseData: Array<ProjectsListCollaboratorsResponseDataItem>

ProjectsListCollaboratorsResponseDataItem

ProjectsListCollaboratorsResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsListColumnsEndpoint

ProjectsListColumnsEndpoint: { page?: number; per_page?: number; project_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • project_id: number

    project_id parameter

ProjectsListColumnsRequestOptions

ProjectsListColumnsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id/columns" }

Type declaration

ProjectsListColumnsResponseData

ProjectsListColumnsResponseData: Array<ProjectsListColumnsResponseDataItem>

ProjectsListColumnsResponseDataItem

ProjectsListColumnsResponseDataItem: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsListForOrgEndpoint

ProjectsListForOrgEndpoint: { org: string; page?: number; per_page?: number; state?: "open" | "closed" | "all" }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

ProjectsListForOrgRequestOptions

ProjectsListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/projects" }

Type declaration

ProjectsListForOrgResponseData

ProjectsListForOrgResponseData: Array<ProjectsListForOrgResponseDataItem>

ProjectsListForOrgResponseDataItem

ProjectsListForOrgResponseDataItem: { body: string; columns_url: string; created_at: string; creator: ProjectsListForOrgResponseDataItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsListForOrgResponseDataItemCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsListForOrgResponseDataItemCreator

ProjectsListForOrgResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsListForRepoEndpoint

ProjectsListForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string; state?: "open" | "closed" | "all" }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

ProjectsListForRepoRequestOptions

ProjectsListForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/projects" }

Type declaration

ProjectsListForRepoResponseData

ProjectsListForRepoResponseData: Array<ProjectsListForRepoResponseDataItem>

ProjectsListForRepoResponseDataItem

ProjectsListForRepoResponseDataItem: { body: string; columns_url: string; created_at: string; creator: ProjectsListForRepoResponseDataItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsListForRepoResponseDataItemCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsListForRepoResponseDataItemCreator

ProjectsListForRepoResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsListForUserEndpoint

ProjectsListForUserEndpoint: { page?: number; per_page?: number; state?: "open" | "closed" | "all"; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

  • username: string

    username parameter

ProjectsListForUserRequestOptions

ProjectsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/projects" }

Type declaration

ProjectsListForUserResponseData

ProjectsListForUserResponseData: Array<ProjectsListForUserResponseDataItem>

ProjectsListForUserResponseDataItem

ProjectsListForUserResponseDataItem: { body: string; columns_url: string; created_at: string; creator: ProjectsListForUserResponseDataItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsListForUserResponseDataItemCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsListForUserResponseDataItemCreator

ProjectsListForUserResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsMoveCardEndpoint

ProjectsMoveCardEndpoint: { card_id: number; column_id?: number; position: string }

Type declaration

  • card_id: number

    card_id parameter

  • Optional column_id?: number

    The id value of a column in the same project.

  • position: string

    Can be one of top, bottom, or after:<card_id>, where <card_id> is the id value of a card in the same column, or in the new column specified by column_id.

ProjectsMoveCardRequestOptions

ProjectsMoveCardRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id/moves" }

Type declaration

ProjectsMoveColumnEndpoint

ProjectsMoveColumnEndpoint: { column_id: number; position: string }

Type declaration

  • column_id: number

    column_id parameter

  • position: string

    Can be one of first, last, or after:<column_id>, where <column_id> is the id value of a column in the same project.

ProjectsMoveColumnRequestOptions

ProjectsMoveColumnRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/columns/:column_id/moves" }

Type declaration

ProjectsRemoveCollaboratorEndpoint

ProjectsRemoveCollaboratorEndpoint: { project_id: number; username: string }

Type declaration

  • project_id: number

    project_id parameter

  • username: string

    username parameter

ProjectsRemoveCollaboratorRequestOptions

ProjectsRemoveCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators/:username" }

Type declaration

ProjectsReviewUserPermissionLevelEndpoint

ProjectsReviewUserPermissionLevelEndpoint: { project_id: number; username: string }

Type declaration

  • project_id: number

    project_id parameter

  • username: string

    username parameter

ProjectsReviewUserPermissionLevelRequestOptions

ProjectsReviewUserPermissionLevelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators/:username/permission" }

Type declaration

ProjectsReviewUserPermissionLevelResponseData

ProjectsReviewUserPermissionLevelResponseData: { permission: string; user: ProjectsReviewUserPermissionLevelResponseDataUser }

Type declaration

ProjectsReviewUserPermissionLevelResponseDataUser

ProjectsReviewUserPermissionLevelResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsUpdateCardEndpoint

ProjectsUpdateCardEndpoint: { archived?: boolean; card_id: number; note?: string }

Type declaration

  • Optional archived?: boolean

    Use true to archive a project card. Specify false if you need to restore a previously archived project card.

  • card_id: number

    card_id parameter

  • Optional note?: string

    The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type.

ProjectsUpdateCardRequestOptions

ProjectsUpdateCardRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id" }

Type declaration

ProjectsUpdateCardResponseData

ProjectsUpdateCardResponseData: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsUpdateCardResponseDataCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsUpdateCardResponseDataCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsUpdateCardResponseDataCreator

ProjectsUpdateCardResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ProjectsUpdateColumnEndpoint

ProjectsUpdateColumnEndpoint: { column_id: number; name: string }

Type declaration

  • column_id: number

    column_id parameter

  • name: string

    The new name of the column.

ProjectsUpdateColumnRequestOptions

ProjectsUpdateColumnRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/projects/columns/:column_id" }

Type declaration

ProjectsUpdateColumnResponseData

ProjectsUpdateColumnResponseData: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsUpdateEndpoint

ProjectsUpdateEndpoint: { body?: string; name?: string; organization_permission?: string; private?: boolean; project_id: number; state?: "open" | "closed" }

Type declaration

  • Optional body?: string

    The description of the project.

  • Optional name?: string

    The name of the project.

  • Optional organization_permission?: string

    The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting organization_permission is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by organization_permission. For information on changing access for a team or collaborator, see Add or update team project or Add user as a collaborator.

    Note: Updating a project's organization_permission requires admin access to the project.

    Can be one of: * read - Organization members can read, but not write to or administer this project. * write - Organization members can read and write, but not administer this project. * admin - Organization members can read, write and administer this project. * none - Organization members can only see this project if it is public.

  • Optional private?: boolean

    Sets the visibility of a project board. Setting private is only available for organization and user projects. Note: Updating a project's visibility requires admin access to the project.

    Can be one of: * false - Anyone can see the project. * true - Only the user can view a project board created on a user account. Organization members with the appropriate organization_permission can see project boards in an organization account.

  • project_id: number

    project_id parameter

  • Optional state?: "open" | "closed"

    State of the project. Either open or closed.

ProjectsUpdateRequestOptions

ProjectsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/projects/:project_id" }

Type declaration

ProjectsUpdateResponseData

ProjectsUpdateResponseData: { body: string; columns_url: string; created_at: string; creator: ProjectsUpdateResponseDataCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsUpdateResponseDataCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsUpdateResponseDataCreator

ProjectsUpdateResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCheckIfMergedEndpoint

PullsCheckIfMergedEndpoint: { owner: string; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsCheckIfMergedRequestOptions

PullsCheckIfMergedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/merge" }

Type declaration

PullsCreateCommentEndpoint

PullsCreateCommentEndpoint: { body: string; commit_id: string; line?: number; owner: string; path: string; position?: number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: number; start_side?: "LEFT" | "RIGHT" | "side" }

Type declaration

  • body: string

    The text of the review comment.

  • commit_id: string

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

  • Optional line?: number

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string

    owner parameter

  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentRequestOptions

PullsCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/comments" }

Type declaration

PullsCreateCommentResponseData

PullsCreateCommentResponseData: { _links: PullsCreateCommentResponseDataLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsCreateCommentResponseDataUser }

Type declaration

  • _links: PullsCreateCommentResponseDataLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsCreateCommentResponseDataUser

PullsCreateCommentResponseDataLinks

PullsCreateCommentResponseDataLinks: { html: PullsCreateCommentResponseDataLinksHtml; pull_request: PullsCreateCommentResponseDataLinksPullRequest; self: PullsCreateCommentResponseDataLinksSelf }

Type declaration

PullsCreateCommentResponseDataLinksHtml

PullsCreateCommentResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsCreateCommentResponseDataLinksPullRequest

PullsCreateCommentResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsCreateCommentResponseDataLinksSelf

PullsCreateCommentResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsCreateCommentResponseDataUser

PullsCreateCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateEndpoint

PullsCreateEndpoint: { base: string; body?: string; draft?: boolean; head: string; maintainer_can_modify?: boolean; owner: string; repo: string; title: string }

Type declaration

  • base: string

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

  • Optional body?: string

    The contents of the pull request.

  • Optional draft?: boolean

    Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.

  • head: string

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

  • Optional maintainer_can_modify?: boolean

    Indicates whether maintainers can modify the pull request.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • title: string

    The title of the new pull request.

PullsCreateRequestOptions

PullsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls" }

Type declaration

PullsCreateResponseData

PullsCreateResponseData: { _links: PullsCreateResponseDataLinks; active_lock_reason: string; additions: number; assignee: PullsCreateResponseDataAssignee; assignees: Array<PullsCreateResponseDataAssigneesItem>; author_association: string; base: PullsCreateResponseDataBase; body: string; changed_files: number; closed_at: string; comments: number; comments_url: string; commits: number; commits_url: string; created_at: string; deletions: number; diff_url: string; draft: boolean; head: PullsCreateResponseDataHead; html_url: string; id: number; issue_url: string; labels: Array<PullsCreateResponseDataLabelsItem>; locked: boolean; maintainer_can_modify: boolean; merge_commit_sha: string; mergeable: boolean; mergeable_state: string; merged: boolean; merged_at: string; merged_by: PullsCreateResponseDataMergedBy; milestone: PullsCreateResponseDataMilestone; node_id: string; number: number; patch_url: string; rebaseable: boolean; requested_reviewers: Array<PullsCreateResponseDataRequestedReviewersItem>; requested_teams: Array<PullsCreateResponseDataRequestedTeamsItem>; review_comment_url: string; review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsCreateResponseDataUser }

Type declaration

PullsCreateResponseDataAssignee

PullsCreateResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataAssigneesItem

PullsCreateResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataBase

PullsCreateResponseDataBase: { label: string; ref: string; repo: PullsCreateResponseDataBaseRepo; sha: string; user: PullsCreateResponseDataBaseUser }

Type declaration

PullsCreateResponseDataBaseRepo

PullsCreateResponseDataBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateResponseDataBaseRepoOwner; permissions: PullsCreateResponseDataBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsCreateResponseDataBaseRepoOwner
  • permissions: PullsCreateResponseDataBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsCreateResponseDataBaseRepoOwner

PullsCreateResponseDataBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataBaseRepoPermissions

PullsCreateResponseDataBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsCreateResponseDataBaseUser

PullsCreateResponseDataBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataHead

PullsCreateResponseDataHead: { label: string; ref: string; repo: PullsCreateResponseDataHeadRepo; sha: string; user: PullsCreateResponseDataHeadUser }

Type declaration

PullsCreateResponseDataHeadRepo

PullsCreateResponseDataHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateResponseDataHeadRepoOwner; permissions: PullsCreateResponseDataHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsCreateResponseDataHeadRepoOwner
  • permissions: PullsCreateResponseDataHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsCreateResponseDataHeadRepoOwner

PullsCreateResponseDataHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataHeadRepoPermissions

PullsCreateResponseDataHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsCreateResponseDataHeadUser

PullsCreateResponseDataHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataLabelsItem

PullsCreateResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

PullsCreateResponseDataLinks

PullsCreateResponseDataLinks: { comments: PullsCreateResponseDataLinksComments; commits: PullsCreateResponseDataLinksCommits; html: PullsCreateResponseDataLinksHtml; issue: PullsCreateResponseDataLinksIssue; review_comment: PullsCreateResponseDataLinksReviewComment; review_comments: PullsCreateResponseDataLinksReviewComments; self: PullsCreateResponseDataLinksSelf; statuses: PullsCreateResponseDataLinksStatuses }

Type declaration

PullsCreateResponseDataLinksComments

PullsCreateResponseDataLinksComments: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataLinksCommits

PullsCreateResponseDataLinksCommits: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataLinksHtml

PullsCreateResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataLinksIssue

PullsCreateResponseDataLinksIssue: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataLinksReviewComment

PullsCreateResponseDataLinksReviewComment: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataLinksReviewComments

PullsCreateResponseDataLinksReviewComments: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataLinksSelf

PullsCreateResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataLinksStatuses

PullsCreateResponseDataLinksStatuses: { href: string }

Type declaration

  • href: string

PullsCreateResponseDataMergedBy

PullsCreateResponseDataMergedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataMilestone

PullsCreateResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsCreateResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsCreateResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsCreateResponseDataMilestoneCreator

PullsCreateResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataRequestedReviewersItem

PullsCreateResponseDataRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateResponseDataRequestedTeamsItem

PullsCreateResponseDataRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

PullsCreateResponseDataUser

PullsCreateResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewCommentReplyEndpoint

PullsCreateReviewCommentReplyEndpoint: { body: string; comment_id: number; owner: string; pull_number: number; repo: string }

Type declaration

  • body: string

    The text of the review comment.

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsCreateReviewCommentReplyRequestOptions

PullsCreateReviewCommentReplyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies" }

Type declaration

PullsCreateReviewCommentReplyResponseData

PullsCreateReviewCommentReplyResponseData: { _links: PullsCreateReviewCommentReplyResponseDataLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; node_id: string; original_commit_id: string; original_position: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; updated_at: string; url: string; user: PullsCreateReviewCommentReplyResponseDataUser }

Type declaration

PullsCreateReviewCommentReplyResponseDataLinks

PullsCreateReviewCommentReplyResponseDataLinks: { html: PullsCreateReviewCommentReplyResponseDataLinksHtml; pull_request: PullsCreateReviewCommentReplyResponseDataLinksPullRequest; self: PullsCreateReviewCommentReplyResponseDataLinksSelf }

Type declaration

PullsCreateReviewCommentReplyResponseDataLinksHtml

PullsCreateReviewCommentReplyResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsCreateReviewCommentReplyResponseDataLinksPullRequest

PullsCreateReviewCommentReplyResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsCreateReviewCommentReplyResponseDataLinksSelf

PullsCreateReviewCommentReplyResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsCreateReviewCommentReplyResponseDataUser

PullsCreateReviewCommentReplyResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewEndpoint

PullsCreateReviewEndpoint: { body?: string; comments?: PullsCreateReviewParamsComments[]; commit_id?: string; event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string }

Type declaration

  • Optional body?: string

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

  • Optional comments?: PullsCreateReviewParamsComments[]

    Use the following table to specify the location, destination, and contents of the draft review comment.

  • Optional commit_id?: string

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

  • Optional event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsCreateReviewParamsComments

PullsCreateReviewParamsComments: { body: string; path: string; position: number }

Type declaration

  • body: string
  • path: string
  • position: number

PullsCreateReviewRequestEndpoint

PullsCreateReviewRequestEndpoint: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional reviewers?: string[]

    An array of user logins that will be requested.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be requested.

PullsCreateReviewRequestOptions

PullsCreateReviewRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews" }

Type declaration

PullsCreateReviewRequestRequestOptions

PullsCreateReviewRequestRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" }

Type declaration

PullsCreateReviewRequestResponseData

PullsCreateReviewRequestResponseData: { _links: PullsCreateReviewRequestResponseDataLinks; active_lock_reason: string; assignee: PullsCreateReviewRequestResponseDataAssignee; assignees: Array<PullsCreateReviewRequestResponseDataAssigneesItem>; author_association: string; base: PullsCreateReviewRequestResponseDataBase; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: PullsCreateReviewRequestResponseDataHead; html_url: string; id: number; issue_url: string; labels: Array<PullsCreateReviewRequestResponseDataLabelsItem>; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: PullsCreateReviewRequestResponseDataMilestone; node_id: string; number: number; patch_url: string; requested_reviewers: Array<PullsCreateReviewRequestResponseDataRequestedReviewersItem>; requested_teams: Array<PullsCreateReviewRequestResponseDataRequestedTeamsItem>; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsCreateReviewRequestResponseDataUser }

Type declaration

PullsCreateReviewRequestResponseDataAssignee

PullsCreateReviewRequestResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataAssigneesItem

PullsCreateReviewRequestResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataBase

PullsCreateReviewRequestResponseDataBase: { label: string; ref: string; repo: PullsCreateReviewRequestResponseDataBaseRepo; sha: string; user: PullsCreateReviewRequestResponseDataBaseUser }

Type declaration

PullsCreateReviewRequestResponseDataBaseRepo

PullsCreateReviewRequestResponseDataBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateReviewRequestResponseDataBaseRepoOwner; permissions: PullsCreateReviewRequestResponseDataBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsCreateReviewRequestResponseDataBaseRepoOwner
  • permissions: PullsCreateReviewRequestResponseDataBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsCreateReviewRequestResponseDataBaseRepoOwner

PullsCreateReviewRequestResponseDataBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataBaseRepoPermissions

PullsCreateReviewRequestResponseDataBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsCreateReviewRequestResponseDataBaseUser

PullsCreateReviewRequestResponseDataBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataHead

PullsCreateReviewRequestResponseDataHead: { label: string; ref: string; repo: PullsCreateReviewRequestResponseDataHeadRepo; sha: string; user: PullsCreateReviewRequestResponseDataHeadUser }

Type declaration

PullsCreateReviewRequestResponseDataHeadRepo

PullsCreateReviewRequestResponseDataHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateReviewRequestResponseDataHeadRepoOwner; permissions: PullsCreateReviewRequestResponseDataHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsCreateReviewRequestResponseDataHeadRepoOwner
  • permissions: PullsCreateReviewRequestResponseDataHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsCreateReviewRequestResponseDataHeadRepoOwner

PullsCreateReviewRequestResponseDataHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataHeadRepoPermissions

PullsCreateReviewRequestResponseDataHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsCreateReviewRequestResponseDataHeadUser

PullsCreateReviewRequestResponseDataHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataLabelsItem

PullsCreateReviewRequestResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

PullsCreateReviewRequestResponseDataLinks

PullsCreateReviewRequestResponseDataLinks: { comments: PullsCreateReviewRequestResponseDataLinksComments; commits: PullsCreateReviewRequestResponseDataLinksCommits; html: PullsCreateReviewRequestResponseDataLinksHtml; issue: PullsCreateReviewRequestResponseDataLinksIssue; review_comment: PullsCreateReviewRequestResponseDataLinksReviewComment; review_comments: PullsCreateReviewRequestResponseDataLinksReviewComments; self: PullsCreateReviewRequestResponseDataLinksSelf; statuses: PullsCreateReviewRequestResponseDataLinksStatuses }

Type declaration

PullsCreateReviewRequestResponseDataLinksComments

PullsCreateReviewRequestResponseDataLinksComments: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataLinksCommits

PullsCreateReviewRequestResponseDataLinksCommits: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataLinksHtml

PullsCreateReviewRequestResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataLinksIssue

PullsCreateReviewRequestResponseDataLinksIssue: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataLinksReviewComment

PullsCreateReviewRequestResponseDataLinksReviewComment: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataLinksReviewComments

PullsCreateReviewRequestResponseDataLinksReviewComments: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataLinksSelf

PullsCreateReviewRequestResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataLinksStatuses

PullsCreateReviewRequestResponseDataLinksStatuses: { href: string }

Type declaration

  • href: string

PullsCreateReviewRequestResponseDataMilestone

PullsCreateReviewRequestResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsCreateReviewRequestResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsCreateReviewRequestResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsCreateReviewRequestResponseDataMilestoneCreator

PullsCreateReviewRequestResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataRequestedReviewersItem

PullsCreateReviewRequestResponseDataRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewRequestResponseDataRequestedTeamsItem

PullsCreateReviewRequestResponseDataRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

PullsCreateReviewRequestResponseDataUser

PullsCreateReviewRequestResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsCreateReviewResponseData

PullsCreateReviewResponseData: { _links: PullsCreateReviewResponseDataLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsCreateReviewResponseDataUser }

Type declaration

PullsCreateReviewResponseDataLinks

PullsCreateReviewResponseDataLinks: { html: PullsCreateReviewResponseDataLinksHtml; pull_request: PullsCreateReviewResponseDataLinksPullRequest }

Type declaration

PullsCreateReviewResponseDataLinksHtml

PullsCreateReviewResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsCreateReviewResponseDataLinksPullRequest

PullsCreateReviewResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsCreateReviewResponseDataUser

PullsCreateReviewResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsDeleteCommentEndpoint

PullsDeleteCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

PullsDeleteCommentRequestOptions

PullsDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id" }

Type declaration

PullsDeletePendingReviewEndpoint

PullsDeletePendingReviewEndpoint: { owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsDeletePendingReviewRequestOptions

PullsDeletePendingReviewRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" }

Type declaration

PullsDeletePendingReviewResponseData

PullsDeletePendingReviewResponseData: { _links: PullsDeletePendingReviewResponseDataLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsDeletePendingReviewResponseDataUser }

Type declaration

PullsDeletePendingReviewResponseDataLinks

PullsDeletePendingReviewResponseDataLinks: { html: PullsDeletePendingReviewResponseDataLinksHtml; pull_request: PullsDeletePendingReviewResponseDataLinksPullRequest }

Type declaration

PullsDeletePendingReviewResponseDataLinksHtml

PullsDeletePendingReviewResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsDeletePendingReviewResponseDataLinksPullRequest

PullsDeletePendingReviewResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsDeletePendingReviewResponseDataUser

PullsDeletePendingReviewResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsDeleteReviewRequestEndpoint

PullsDeleteReviewRequestEndpoint: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional reviewers?: string[]

    An array of user logins that will be removed.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be removed.

PullsDeleteReviewRequestRequestOptions

PullsDeleteReviewRequestRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" }

Type declaration

PullsDismissReviewEndpoint

PullsDismissReviewEndpoint: { message: string; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • message: string

    The message for the pull request review dismissal

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsDismissReviewRequestOptions

PullsDismissReviewRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals" }

Type declaration

PullsDismissReviewResponseData

PullsDismissReviewResponseData: { _links: PullsDismissReviewResponseDataLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsDismissReviewResponseDataUser }

Type declaration

PullsDismissReviewResponseDataLinks

PullsDismissReviewResponseDataLinks: { html: PullsDismissReviewResponseDataLinksHtml; pull_request: PullsDismissReviewResponseDataLinksPullRequest }

Type declaration

PullsDismissReviewResponseDataLinksHtml

PullsDismissReviewResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsDismissReviewResponseDataLinksPullRequest

PullsDismissReviewResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsDismissReviewResponseDataUser

PullsDismissReviewResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetCommentEndpoint

PullsGetCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

PullsGetCommentRequestOptions

PullsGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id" }

Type declaration

PullsGetCommentResponseData

PullsGetCommentResponseData: { _links: PullsGetCommentResponseDataLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsGetCommentResponseDataUser }

Type declaration

  • _links: PullsGetCommentResponseDataLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsGetCommentResponseDataUser

PullsGetCommentResponseDataLinks

PullsGetCommentResponseDataLinks: { html: PullsGetCommentResponseDataLinksHtml; pull_request: PullsGetCommentResponseDataLinksPullRequest; self: PullsGetCommentResponseDataLinksSelf }

Type declaration

PullsGetCommentResponseDataLinksHtml

PullsGetCommentResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsGetCommentResponseDataLinksPullRequest

PullsGetCommentResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsGetCommentResponseDataLinksSelf

PullsGetCommentResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsGetCommentResponseDataUser

PullsGetCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetCommentsForReviewEndpoint

PullsGetCommentsForReviewEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsGetCommentsForReviewRequestOptions

PullsGetCommentsForReviewRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments" }

Type declaration

PullsGetCommentsForReviewResponseData

PullsGetCommentsForReviewResponseData: Array<PullsGetCommentsForReviewResponseDataItem>

PullsGetCommentsForReviewResponseDataItem

PullsGetCommentsForReviewResponseDataItem: { _links: PullsGetCommentsForReviewResponseDataItemLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; node_id: string; original_commit_id: string; original_position: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; updated_at: string; url: string; user: PullsGetCommentsForReviewResponseDataItemUser }

Type declaration

PullsGetCommentsForReviewResponseDataItemLinks

PullsGetCommentsForReviewResponseDataItemLinks: { html: PullsGetCommentsForReviewResponseDataItemLinksHtml; pull_request: PullsGetCommentsForReviewResponseDataItemLinksPullRequest; self: PullsGetCommentsForReviewResponseDataItemLinksSelf }

Type declaration

PullsGetCommentsForReviewResponseDataItemLinksHtml

PullsGetCommentsForReviewResponseDataItemLinksHtml: { href: string }

Type declaration

  • href: string

PullsGetCommentsForReviewResponseDataItemLinksPullRequest

PullsGetCommentsForReviewResponseDataItemLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsGetCommentsForReviewResponseDataItemLinksSelf

PullsGetCommentsForReviewResponseDataItemLinksSelf: { href: string }

Type declaration

  • href: string

PullsGetCommentsForReviewResponseDataItemUser

PullsGetCommentsForReviewResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetEndpoint

PullsGetEndpoint: { owner: string; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsGetRequestOptions

PullsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number" }

Type declaration

PullsGetResponseData

PullsGetResponseData: { _links: PullsGetResponseDataLinks; active_lock_reason: string; additions: number; assignee: PullsGetResponseDataAssignee; assignees: Array<PullsGetResponseDataAssigneesItem>; author_association: string; base: PullsGetResponseDataBase; body: string; changed_files: number; closed_at: string; comments: number; comments_url: string; commits: number; commits_url: string; created_at: string; deletions: number; diff_url: string; draft: boolean; head: PullsGetResponseDataHead; html_url: string; id: number; issue_url: string; labels: Array<PullsGetResponseDataLabelsItem>; locked: boolean; maintainer_can_modify: boolean; merge_commit_sha: string; mergeable: boolean; mergeable_state: string; merged: boolean; merged_at: string; merged_by: PullsGetResponseDataMergedBy; milestone: PullsGetResponseDataMilestone; node_id: string; number: number; patch_url: string; rebaseable: boolean; requested_reviewers: Array<PullsGetResponseDataRequestedReviewersItem>; requested_teams: Array<PullsGetResponseDataRequestedTeamsItem>; review_comment_url: string; review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsGetResponseDataUser }

Type declaration

PullsGetResponseDataAssignee

PullsGetResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataAssigneesItem

PullsGetResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataBase

PullsGetResponseDataBase: { label: string; ref: string; repo: PullsGetResponseDataBaseRepo; sha: string; user: PullsGetResponseDataBaseUser }

Type declaration

PullsGetResponseDataBaseRepo

PullsGetResponseDataBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsGetResponseDataBaseRepoOwner; permissions: PullsGetResponseDataBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsGetResponseDataBaseRepoOwner
  • permissions: PullsGetResponseDataBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsGetResponseDataBaseRepoOwner

PullsGetResponseDataBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataBaseRepoPermissions

PullsGetResponseDataBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsGetResponseDataBaseUser

PullsGetResponseDataBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataHead

PullsGetResponseDataHead: { label: string; ref: string; repo: PullsGetResponseDataHeadRepo; sha: string; user: PullsGetResponseDataHeadUser }

Type declaration

PullsGetResponseDataHeadRepo

PullsGetResponseDataHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsGetResponseDataHeadRepoOwner; permissions: PullsGetResponseDataHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsGetResponseDataHeadRepoOwner
  • permissions: PullsGetResponseDataHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsGetResponseDataHeadRepoOwner

PullsGetResponseDataHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataHeadRepoPermissions

PullsGetResponseDataHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsGetResponseDataHeadUser

PullsGetResponseDataHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataLabelsItem

PullsGetResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

PullsGetResponseDataLinks

PullsGetResponseDataLinks: { comments: PullsGetResponseDataLinksComments; commits: PullsGetResponseDataLinksCommits; html: PullsGetResponseDataLinksHtml; issue: PullsGetResponseDataLinksIssue; review_comment: PullsGetResponseDataLinksReviewComment; review_comments: PullsGetResponseDataLinksReviewComments; self: PullsGetResponseDataLinksSelf; statuses: PullsGetResponseDataLinksStatuses }

Type declaration

PullsGetResponseDataLinksComments

PullsGetResponseDataLinksComments: { href: string }

Type declaration

  • href: string

PullsGetResponseDataLinksCommits

PullsGetResponseDataLinksCommits: { href: string }

Type declaration

  • href: string

PullsGetResponseDataLinksHtml

PullsGetResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsGetResponseDataLinksIssue

PullsGetResponseDataLinksIssue: { href: string }

Type declaration

  • href: string

PullsGetResponseDataLinksReviewComment

PullsGetResponseDataLinksReviewComment: { href: string }

Type declaration

  • href: string

PullsGetResponseDataLinksReviewComments

PullsGetResponseDataLinksReviewComments: { href: string }

Type declaration

  • href: string

PullsGetResponseDataLinksSelf

PullsGetResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsGetResponseDataLinksStatuses

PullsGetResponseDataLinksStatuses: { href: string }

Type declaration

  • href: string

PullsGetResponseDataMergedBy

PullsGetResponseDataMergedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataMilestone

PullsGetResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsGetResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsGetResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsGetResponseDataMilestoneCreator

PullsGetResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataRequestedReviewersItem

PullsGetResponseDataRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetResponseDataRequestedTeamsItem

PullsGetResponseDataRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

PullsGetResponseDataUser

PullsGetResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsGetReviewEndpoint

PullsGetReviewEndpoint: { owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsGetReviewRequestOptions

PullsGetReviewRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" }

Type declaration

PullsGetReviewResponseData

PullsGetReviewResponseData: { _links: PullsGetReviewResponseDataLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; submitted_at: string; user: PullsGetReviewResponseDataUser }

Type declaration

PullsGetReviewResponseDataLinks

PullsGetReviewResponseDataLinks: { html: PullsGetReviewResponseDataLinksHtml; pull_request: PullsGetReviewResponseDataLinksPullRequest }

Type declaration

PullsGetReviewResponseDataLinksHtml

PullsGetReviewResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsGetReviewResponseDataLinksPullRequest

PullsGetReviewResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsGetReviewResponseDataUser

PullsGetReviewResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListCommentsEndpoint

PullsListCommentsEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; pull_number: number; repo: string; since?: string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be either asc or desc. Ignored without sort parameter.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

  • Optional sort?: "created" | "updated"

    Can be either created or updated comments.

PullsListCommentsForRepoEndpoint

PullsListCommentsForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; repo: string; since?: string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be either asc or desc. Ignored without sort parameter.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

  • Optional sort?: "created" | "updated"

    Can be either created or updated comments.

PullsListCommentsForRepoRequestOptions

PullsListCommentsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments" }

Type declaration

PullsListCommentsForRepoResponseData

PullsListCommentsForRepoResponseData: Array<PullsListCommentsForRepoResponseDataItem>

PullsListCommentsForRepoResponseDataItem

PullsListCommentsForRepoResponseDataItem: { _links: PullsListCommentsForRepoResponseDataItemLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsListCommentsForRepoResponseDataItemUser }

Type declaration

  • _links: PullsListCommentsForRepoResponseDataItemLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsListCommentsForRepoResponseDataItemUser

PullsListCommentsForRepoResponseDataItemLinks

PullsListCommentsForRepoResponseDataItemLinks: { html: PullsListCommentsForRepoResponseDataItemLinksHtml; pull_request: PullsListCommentsForRepoResponseDataItemLinksPullRequest; self: PullsListCommentsForRepoResponseDataItemLinksSelf }

Type declaration

PullsListCommentsForRepoResponseDataItemLinksHtml

PullsListCommentsForRepoResponseDataItemLinksHtml: { href: string }

Type declaration

  • href: string

PullsListCommentsForRepoResponseDataItemLinksPullRequest

PullsListCommentsForRepoResponseDataItemLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsListCommentsForRepoResponseDataItemLinksSelf

PullsListCommentsForRepoResponseDataItemLinksSelf: { href: string }

Type declaration

  • href: string

PullsListCommentsForRepoResponseDataItemUser

PullsListCommentsForRepoResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListCommentsRequestOptions

PullsListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/comments" }

Type declaration

PullsListCommentsResponseData

PullsListCommentsResponseData: Array<PullsListCommentsResponseDataItem>

PullsListCommentsResponseDataItem

PullsListCommentsResponseDataItem: { _links: PullsListCommentsResponseDataItemLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsListCommentsResponseDataItemUser }

Type declaration

  • _links: PullsListCommentsResponseDataItemLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsListCommentsResponseDataItemUser

PullsListCommentsResponseDataItemLinks

PullsListCommentsResponseDataItemLinks: { html: PullsListCommentsResponseDataItemLinksHtml; pull_request: PullsListCommentsResponseDataItemLinksPullRequest; self: PullsListCommentsResponseDataItemLinksSelf }

Type declaration

PullsListCommentsResponseDataItemLinksHtml

PullsListCommentsResponseDataItemLinksHtml: { href: string }

Type declaration

  • href: string

PullsListCommentsResponseDataItemLinksPullRequest

PullsListCommentsResponseDataItemLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsListCommentsResponseDataItemLinksSelf

PullsListCommentsResponseDataItemLinksSelf: { href: string }

Type declaration

  • href: string

PullsListCommentsResponseDataItemUser

PullsListCommentsResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListCommitsEndpoint

PullsListCommitsEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListCommitsRequestOptions

PullsListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/commits" }

Type declaration

PullsListCommitsResponseData

PullsListCommitsResponseData: Array<PullsListCommitsResponseDataItem>

PullsListCommitsResponseDataItem

PullsListCommitsResponseDataItem: { author: PullsListCommitsResponseDataItemAuthor; comments_url: string; commit: PullsListCommitsResponseDataItemCommit; committer: PullsListCommitsResponseDataItemCommitter; html_url: string; node_id: string; parents: Array<PullsListCommitsResponseDataItemParentsItem>; sha: string; url: string }

Type declaration

PullsListCommitsResponseDataItemAuthor

PullsListCommitsResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListCommitsResponseDataItemCommit

PullsListCommitsResponseDataItemCommit: { author: PullsListCommitsResponseDataItemCommitAuthor; comment_count: number; committer: PullsListCommitsResponseDataItemCommitCommitter; message: string; tree: PullsListCommitsResponseDataItemCommitTree; url: string; verification: PullsListCommitsResponseDataItemCommitVerification }

Type declaration

PullsListCommitsResponseDataItemCommitAuthor

PullsListCommitsResponseDataItemCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

PullsListCommitsResponseDataItemCommitCommitter

PullsListCommitsResponseDataItemCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

PullsListCommitsResponseDataItemCommitTree

PullsListCommitsResponseDataItemCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

PullsListCommitsResponseDataItemCommitVerification

PullsListCommitsResponseDataItemCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

PullsListCommitsResponseDataItemCommitter

PullsListCommitsResponseDataItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListCommitsResponseDataItemParentsItem

PullsListCommitsResponseDataItemParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

PullsListEndpoint

PullsListEndpoint: { base?: string; direction?: "asc" | "desc"; head?: string; owner: string; page?: number; per_page?: number; repo: string; sort?: "created" | "updated" | "popularity" | "long-running"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional base?: string

    Filter pulls by base branch name. Example: gh-pages.

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.

  • Optional head?: string

    Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sort?: "created" | "updated" | "popularity" | "long-running"

    What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).

  • Optional state?: "open" | "closed" | "all"

    Either open, closed, or all to filter by state.

PullsListFilesEndpoint

PullsListFilesEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListFilesRequestOptions

PullsListFilesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/files" }

Type declaration

PullsListFilesResponseData

PullsListFilesResponseData: Array<PullsListFilesResponseDataItem>

PullsListFilesResponseDataItem

PullsListFilesResponseDataItem: { additions: number; blob_url: string; changes: number; contents_url: string; deletions: number; filename: string; patch: string; raw_url: string; sha: string; status: string }

Type declaration

  • additions: number
  • blob_url: string
  • changes: number
  • contents_url: string
  • deletions: number
  • filename: string
  • patch: string
  • raw_url: string
  • sha: string
  • status: string

PullsListRequestOptions

PullsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls" }

Type declaration

PullsListResponseData

PullsListResponseData: Array<PullsListResponseDataItem>

PullsListResponseDataItem

PullsListResponseDataItem: { _links: PullsListResponseDataItemLinks; active_lock_reason: string; assignee: PullsListResponseDataItemAssignee; assignees: Array<PullsListResponseDataItemAssigneesItem>; author_association: string; base: PullsListResponseDataItemBase; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: PullsListResponseDataItemHead; html_url: string; id: number; issue_url: string; labels: Array<PullsListResponseDataItemLabelsItem>; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: PullsListResponseDataItemMilestone; node_id: string; number: number; patch_url: string; requested_reviewers: Array<PullsListResponseDataItemRequestedReviewersItem>; requested_teams: Array<PullsListResponseDataItemRequestedTeamsItem>; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsListResponseDataItemUser }

Type declaration

PullsListResponseDataItemAssignee

PullsListResponseDataItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemAssigneesItem

PullsListResponseDataItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemBase

PullsListResponseDataItemBase: { label: string; ref: string; repo: PullsListResponseDataItemBaseRepo; sha: string; user: PullsListResponseDataItemBaseUser }

Type declaration

PullsListResponseDataItemBaseRepo

PullsListResponseDataItemBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsListResponseDataItemBaseRepoOwner; permissions: PullsListResponseDataItemBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsListResponseDataItemBaseRepoOwner
  • permissions: PullsListResponseDataItemBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsListResponseDataItemBaseRepoOwner

PullsListResponseDataItemBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemBaseRepoPermissions

PullsListResponseDataItemBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsListResponseDataItemBaseUser

PullsListResponseDataItemBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemHead

PullsListResponseDataItemHead: { label: string; ref: string; repo: PullsListResponseDataItemHeadRepo; sha: string; user: PullsListResponseDataItemHeadUser }

Type declaration

PullsListResponseDataItemHeadRepo

PullsListResponseDataItemHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsListResponseDataItemHeadRepoOwner; permissions: PullsListResponseDataItemHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsListResponseDataItemHeadRepoOwner
  • permissions: PullsListResponseDataItemHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsListResponseDataItemHeadRepoOwner

PullsListResponseDataItemHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemHeadRepoPermissions

PullsListResponseDataItemHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsListResponseDataItemHeadUser

PullsListResponseDataItemHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemLabelsItem

PullsListResponseDataItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

PullsListResponseDataItemLinks

PullsListResponseDataItemLinks: { comments: PullsListResponseDataItemLinksComments; commits: PullsListResponseDataItemLinksCommits; html: PullsListResponseDataItemLinksHtml; issue: PullsListResponseDataItemLinksIssue; review_comment: PullsListResponseDataItemLinksReviewComment; review_comments: PullsListResponseDataItemLinksReviewComments; self: PullsListResponseDataItemLinksSelf; statuses: PullsListResponseDataItemLinksStatuses }

Type declaration

PullsListResponseDataItemLinksComments

PullsListResponseDataItemLinksComments: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemLinksCommits

PullsListResponseDataItemLinksCommits: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemLinksHtml

PullsListResponseDataItemLinksHtml: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemLinksIssue

PullsListResponseDataItemLinksIssue: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemLinksReviewComment

PullsListResponseDataItemLinksReviewComment: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemLinksReviewComments

PullsListResponseDataItemLinksReviewComments: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemLinksSelf

PullsListResponseDataItemLinksSelf: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemLinksStatuses

PullsListResponseDataItemLinksStatuses: { href: string }

Type declaration

  • href: string

PullsListResponseDataItemMilestone

PullsListResponseDataItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsListResponseDataItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsListResponseDataItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsListResponseDataItemMilestoneCreator

PullsListResponseDataItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemRequestedReviewersItem

PullsListResponseDataItemRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListResponseDataItemRequestedTeamsItem

PullsListResponseDataItemRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

PullsListResponseDataItemUser

PullsListResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListReviewRequestsEndpoint

PullsListReviewRequestsEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListReviewRequestsRequestOptions

PullsListReviewRequestsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" }

Type declaration

PullsListReviewRequestsResponseData

PullsListReviewRequestsResponseData: { teams: Array<PullsListReviewRequestsResponseDataTeamsItem>; users: Array<PullsListReviewRequestsResponseDataUsersItem> }

Type declaration

PullsListReviewRequestsResponseDataTeamsItem

PullsListReviewRequestsResponseDataTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

PullsListReviewRequestsResponseDataUsersItem

PullsListReviewRequestsResponseDataUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsListReviewsEndpoint

PullsListReviewsEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListReviewsRequestOptions

PullsListReviewsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews" }

Type declaration

PullsListReviewsResponseData

PullsListReviewsResponseData: Array<PullsListReviewsResponseDataItem>

PullsListReviewsResponseDataItem

PullsListReviewsResponseDataItem: { _links: PullsListReviewsResponseDataItemLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; submitted_at: string; user: PullsListReviewsResponseDataItemUser }

Type declaration

PullsListReviewsResponseDataItemLinks

PullsListReviewsResponseDataItemLinks: { html: PullsListReviewsResponseDataItemLinksHtml; pull_request: PullsListReviewsResponseDataItemLinksPullRequest }

Type declaration

PullsListReviewsResponseDataItemLinksHtml

PullsListReviewsResponseDataItemLinksHtml: { href: string }

Type declaration

  • href: string

PullsListReviewsResponseDataItemLinksPullRequest

PullsListReviewsResponseDataItemLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsListReviewsResponseDataItemUser

PullsListReviewsResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsMergeEndpoint

PullsMergeEndpoint: { commit_message?: string; commit_title?: string; merge_method?: "merge" | "squash" | "rebase"; owner: string; pull_number: number; repo: string; sha?: string }

Type declaration

  • Optional commit_message?: string

    Extra detail to append to automatic commit message.

  • Optional commit_title?: string

    Title for the automatic commit message.

  • Optional merge_method?: "merge" | "squash" | "rebase"

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional sha?: string

    SHA that pull request head must match to allow merge.

PullsMergeRequestOptions

PullsMergeRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/merge" }

Type declaration

PullsMergeResponseData

PullsMergeResponseData: { merged: boolean; message: string; sha: string }

Type declaration

  • merged: boolean
  • message: string
  • sha: string

PullsSubmitReviewEndpoint

PullsSubmitReviewEndpoint: { body?: string; event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • Optional body?: string

    The body text of the pull request review

  • event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsSubmitReviewRequestOptions

PullsSubmitReviewRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events" }

Type declaration

PullsSubmitReviewResponseData

PullsSubmitReviewResponseData: { _links: PullsSubmitReviewResponseDataLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; submitted_at: string; user: PullsSubmitReviewResponseDataUser }

Type declaration

PullsSubmitReviewResponseDataLinks

PullsSubmitReviewResponseDataLinks: { html: PullsSubmitReviewResponseDataLinksHtml; pull_request: PullsSubmitReviewResponseDataLinksPullRequest }

Type declaration

PullsSubmitReviewResponseDataLinksHtml

PullsSubmitReviewResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsSubmitReviewResponseDataLinksPullRequest

PullsSubmitReviewResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsSubmitReviewResponseDataUser

PullsSubmitReviewResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateBranchEndpoint

PullsUpdateBranchEndpoint: { expected_head_sha?: string; owner: string; pull_number: number; repo: string }

Type declaration

  • Optional expected_head_sha?: string

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits on a repository" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsUpdateBranchRequestOptions

PullsUpdateBranchRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/update-branch" }

Type declaration

PullsUpdateBranchResponseData

PullsUpdateBranchResponseData: { message: string; url: string }

Type declaration

  • message: string
  • url: string

PullsUpdateCommentEndpoint

PullsUpdateCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The text of the reply to the review comment.

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

PullsUpdateCommentRequestOptions

PullsUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id" }

Type declaration

PullsUpdateCommentResponseData

PullsUpdateCommentResponseData: { _links: PullsUpdateCommentResponseDataLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsUpdateCommentResponseDataUser }

Type declaration

  • _links: PullsUpdateCommentResponseDataLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsUpdateCommentResponseDataUser

PullsUpdateCommentResponseDataLinks

PullsUpdateCommentResponseDataLinks: { html: PullsUpdateCommentResponseDataLinksHtml; pull_request: PullsUpdateCommentResponseDataLinksPullRequest; self: PullsUpdateCommentResponseDataLinksSelf }

Type declaration

PullsUpdateCommentResponseDataLinksHtml

PullsUpdateCommentResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsUpdateCommentResponseDataLinksPullRequest

PullsUpdateCommentResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsUpdateCommentResponseDataLinksSelf

PullsUpdateCommentResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsUpdateCommentResponseDataUser

PullsUpdateCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateEndpoint

PullsUpdateEndpoint: { base?: string; body?: string; maintainer_can_modify?: boolean; owner: string; pull_number: number; repo: string; state?: "open" | "closed"; title?: string }

Type declaration

  • Optional base?: string

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

  • Optional body?: string

    The contents of the pull request.

  • Optional maintainer_can_modify?: boolean

    Indicates whether maintainers can modify the pull request.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    State of this Pull Request. Either open or closed.

  • Optional title?: string

    The title of the pull request.

PullsUpdateRequestOptions

PullsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number" }

Type declaration

PullsUpdateResponseData

PullsUpdateResponseData: { _links: PullsUpdateResponseDataLinks; active_lock_reason: string; additions: number; assignee: PullsUpdateResponseDataAssignee; assignees: Array<PullsUpdateResponseDataAssigneesItem>; author_association: string; base: PullsUpdateResponseDataBase; body: string; changed_files: number; closed_at: string; comments: number; comments_url: string; commits: number; commits_url: string; created_at: string; deletions: number; diff_url: string; draft: boolean; head: PullsUpdateResponseDataHead; html_url: string; id: number; issue_url: string; labels: Array<PullsUpdateResponseDataLabelsItem>; locked: boolean; maintainer_can_modify: boolean; merge_commit_sha: string; mergeable: boolean; mergeable_state: string; merged: boolean; merged_at: string; merged_by: PullsUpdateResponseDataMergedBy; milestone: PullsUpdateResponseDataMilestone; node_id: string; number: number; patch_url: string; rebaseable: boolean; requested_reviewers: Array<PullsUpdateResponseDataRequestedReviewersItem>; requested_teams: Array<PullsUpdateResponseDataRequestedTeamsItem>; review_comment_url: string; review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsUpdateResponseDataUser }

Type declaration

PullsUpdateResponseDataAssignee

PullsUpdateResponseDataAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataAssigneesItem

PullsUpdateResponseDataAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataBase

PullsUpdateResponseDataBase: { label: string; ref: string; repo: PullsUpdateResponseDataBaseRepo; sha: string; user: PullsUpdateResponseDataBaseUser }

Type declaration

PullsUpdateResponseDataBaseRepo

PullsUpdateResponseDataBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsUpdateResponseDataBaseRepoOwner; permissions: PullsUpdateResponseDataBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsUpdateResponseDataBaseRepoOwner
  • permissions: PullsUpdateResponseDataBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsUpdateResponseDataBaseRepoOwner

PullsUpdateResponseDataBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataBaseRepoPermissions

PullsUpdateResponseDataBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsUpdateResponseDataBaseUser

PullsUpdateResponseDataBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataHead

PullsUpdateResponseDataHead: { label: string; ref: string; repo: PullsUpdateResponseDataHeadRepo; sha: string; user: PullsUpdateResponseDataHeadUser }

Type declaration

PullsUpdateResponseDataHeadRepo

PullsUpdateResponseDataHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsUpdateResponseDataHeadRepoOwner; permissions: PullsUpdateResponseDataHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: PullsUpdateResponseDataHeadRepoOwner
  • permissions: PullsUpdateResponseDataHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

PullsUpdateResponseDataHeadRepoOwner

PullsUpdateResponseDataHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataHeadRepoPermissions

PullsUpdateResponseDataHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

PullsUpdateResponseDataHeadUser

PullsUpdateResponseDataHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataLabelsItem

PullsUpdateResponseDataLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

PullsUpdateResponseDataLinks

PullsUpdateResponseDataLinks: { comments: PullsUpdateResponseDataLinksComments; commits: PullsUpdateResponseDataLinksCommits; html: PullsUpdateResponseDataLinksHtml; issue: PullsUpdateResponseDataLinksIssue; review_comment: PullsUpdateResponseDataLinksReviewComment; review_comments: PullsUpdateResponseDataLinksReviewComments; self: PullsUpdateResponseDataLinksSelf; statuses: PullsUpdateResponseDataLinksStatuses }

Type declaration

PullsUpdateResponseDataLinksComments

PullsUpdateResponseDataLinksComments: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataLinksCommits

PullsUpdateResponseDataLinksCommits: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataLinksHtml

PullsUpdateResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataLinksIssue

PullsUpdateResponseDataLinksIssue: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataLinksReviewComment

PullsUpdateResponseDataLinksReviewComment: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataLinksReviewComments

PullsUpdateResponseDataLinksReviewComments: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataLinksSelf

PullsUpdateResponseDataLinksSelf: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataLinksStatuses

PullsUpdateResponseDataLinksStatuses: { href: string }

Type declaration

  • href: string

PullsUpdateResponseDataMergedBy

PullsUpdateResponseDataMergedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataMilestone

PullsUpdateResponseDataMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsUpdateResponseDataMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsUpdateResponseDataMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsUpdateResponseDataMilestoneCreator

PullsUpdateResponseDataMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataRequestedReviewersItem

PullsUpdateResponseDataRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateResponseDataRequestedTeamsItem

PullsUpdateResponseDataRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

PullsUpdateResponseDataUser

PullsUpdateResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

PullsUpdateReviewEndpoint

PullsUpdateReviewEndpoint: { body: string; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • body: string

    The body text of the pull request review.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsUpdateReviewRequestOptions

PullsUpdateReviewRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" }

Type declaration

PullsUpdateReviewResponseData

PullsUpdateReviewResponseData: { _links: PullsUpdateReviewResponseDataLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsUpdateReviewResponseDataUser }

Type declaration

PullsUpdateReviewResponseDataLinks

PullsUpdateReviewResponseDataLinks: { html: PullsUpdateReviewResponseDataLinksHtml; pull_request: PullsUpdateReviewResponseDataLinksPullRequest }

Type declaration

PullsUpdateReviewResponseDataLinksHtml

PullsUpdateReviewResponseDataLinksHtml: { href: string }

Type declaration

  • href: string

PullsUpdateReviewResponseDataLinksPullRequest

PullsUpdateReviewResponseDataLinksPullRequest: { href: string }

Type declaration

  • href: string

PullsUpdateReviewResponseDataUser

PullsUpdateReviewResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

RateLimitGetEndpoint

RateLimitGetEndpoint: {}

Type declaration

RateLimitGetRequestOptions

RateLimitGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/rate_limit" }

Type declaration

RateLimitGetResponseData

RateLimitGetResponseData: { rate: RateLimitGetResponseDataRate; resources: RateLimitGetResponseDataResources }

Type declaration

RateLimitGetResponseDataRate

RateLimitGetResponseDataRate: { limit: number; remaining: number; reset: number }

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseDataResources

RateLimitGetResponseDataResources: { core: RateLimitGetResponseDataResourcesCore; graphql: RateLimitGetResponseDataResourcesGraphql; integration_manifest: RateLimitGetResponseDataResourcesIntegrationManifest; search: RateLimitGetResponseDataResourcesSearch }

Type declaration

RateLimitGetResponseDataResourcesCore

RateLimitGetResponseDataResourcesCore: { limit: number; remaining: number; reset: number }

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseDataResourcesGraphql

RateLimitGetResponseDataResourcesGraphql: { limit: number; remaining: number; reset: number }

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseDataResourcesIntegrationManifest

RateLimitGetResponseDataResourcesIntegrationManifest: { limit: number; remaining: number; reset: number }

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseDataResourcesSearch

RateLimitGetResponseDataResourcesSearch: { limit: number; remaining: number; reset: number }

Type declaration

  • limit: number
  • remaining: number
  • reset: number

ReactionsCreateForCommitCommentEndpoint

ReactionsCreateForCommitCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the commit comment.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForCommitCommentRequestOptions

ReactionsCreateForCommitCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id/reactions" }

Type declaration

ReactionsCreateForCommitCommentResponseData

ReactionsCreateForCommitCommentResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForCommitCommentResponseDataUser }

Type declaration

ReactionsCreateForCommitCommentResponseDataUser

ReactionsCreateForCommitCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsCreateForIssueCommentEndpoint

ReactionsCreateForIssueCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the issue comment.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForIssueCommentRequestOptions

ReactionsCreateForIssueCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions" }

Type declaration

ReactionsCreateForIssueCommentResponseData

ReactionsCreateForIssueCommentResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForIssueCommentResponseDataUser }

Type declaration

ReactionsCreateForIssueCommentResponseDataUser

ReactionsCreateForIssueCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsCreateForIssueEndpoint

ReactionsCreateForIssueEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; repo: string }

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the issue.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForIssueRequestOptions

ReactionsCreateForIssueRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/reactions" }

Type declaration

ReactionsCreateForIssueResponseData

ReactionsCreateForIssueResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForIssueResponseDataUser }

Type declaration

ReactionsCreateForIssueResponseDataUser

ReactionsCreateForIssueResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsCreateForPullRequestReviewCommentEndpoint

ReactionsCreateForPullRequestReviewCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the pull request review comment.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForPullRequestReviewCommentRequestOptions

ReactionsCreateForPullRequestReviewCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" }

Type declaration

ReactionsCreateForPullRequestReviewCommentResponseData

ReactionsCreateForPullRequestReviewCommentResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForPullRequestReviewCommentResponseDataUser }

Type declaration

ReactionsCreateForPullRequestReviewCommentResponseDataUser

ReactionsCreateForPullRequestReviewCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionCommentInOrgResponseData

ReactionsCreateForTeamDiscussionCommentInOrgResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser }

Type declaration

ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser

ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionCommentLegacyResponseData

ReactionsCreateForTeamDiscussionCommentLegacyResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser }

Type declaration

ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser

ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsCreateForTeamDiscussionInOrgEndpoint

ReactionsCreateForTeamDiscussionInOrgEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string }

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

ReactionsCreateForTeamDiscussionInOrgRequestOptions

ReactionsCreateForTeamDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionInOrgResponseData

ReactionsCreateForTeamDiscussionInOrgResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionInOrgResponseDataUser }

Type declaration

ReactionsCreateForTeamDiscussionInOrgResponseDataUser

ReactionsCreateForTeamDiscussionInOrgResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsCreateForTeamDiscussionLegacyEndpoint

ReactionsCreateForTeamDiscussionLegacyEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

ReactionsCreateForTeamDiscussionLegacyRequestOptions

ReactionsCreateForTeamDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionLegacyResponseData

ReactionsCreateForTeamDiscussionLegacyResponseData: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionLegacyResponseDataUser }

Type declaration

ReactionsCreateForTeamDiscussionLegacyResponseDataUser

ReactionsCreateForTeamDiscussionLegacyResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsDeleteForCommitCommentEndpoint

ReactionsDeleteForCommitCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForCommitCommentRequestOptions

ReactionsDeleteForCommitCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForIssueCommentEndpoint

ReactionsDeleteForIssueCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForIssueCommentRequestOptions

ReactionsDeleteForIssueCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForIssueEndpoint

ReactionsDeleteForIssueEndpoint: { issue_number: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForIssueRequestOptions

ReactionsDeleteForIssueRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForPullRequestCommentEndpoint

ReactionsDeleteForPullRequestCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForPullRequestCommentRequestOptions

ReactionsDeleteForPullRequestCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForTeamDiscussionCommentEndpoint

ReactionsDeleteForTeamDiscussionCommentEndpoint: { comment_number: number; discussion_number: number; org: string; reaction_id: number; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • reaction_id: number

    reaction_id parameter

  • team_slug: string

    team_slug parameter

ReactionsDeleteForTeamDiscussionCommentRequestOptions

ReactionsDeleteForTeamDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id" }

Type declaration

  • headers: RequestHeaders
  • method: "DELETE"
  • request: RequestRequestOptions
  • url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"

ReactionsDeleteForTeamDiscussionEndpoint

ReactionsDeleteForTeamDiscussionEndpoint: { discussion_number: number; org: string; reaction_id: number; team_slug: string }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • reaction_id: number

    reaction_id parameter

  • team_slug: string

    team_slug parameter

ReactionsDeleteForTeamDiscussionRequestOptions

ReactionsDeleteForTeamDiscussionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id" }

Type declaration

ReactionsDeleteLegacyEndpoint

ReactionsDeleteLegacyEndpoint: { reaction_id: number }

Type declaration

  • reaction_id: number

    reaction_id parameter

ReactionsDeleteLegacyRequestOptions

ReactionsDeleteLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/reactions/:reaction_id" }

Type declaration

ReactionsListForCommitCommentEndpoint

ReactionsListForCommitCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForCommitCommentRequestOptions

ReactionsListForCommitCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id/reactions" }

Type declaration

ReactionsListForCommitCommentResponseData

ReactionsListForCommitCommentResponseData: Array<ReactionsListForCommitCommentResponseDataItem>

ReactionsListForCommitCommentResponseDataItem

ReactionsListForCommitCommentResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForCommitCommentResponseDataItemUser }

Type declaration

ReactionsListForCommitCommentResponseDataItemUser

ReactionsListForCommitCommentResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsListForIssueCommentEndpoint

ReactionsListForIssueCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForIssueCommentRequestOptions

ReactionsListForIssueCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions" }

Type declaration

ReactionsListForIssueCommentResponseData

ReactionsListForIssueCommentResponseData: Array<ReactionsListForIssueCommentResponseDataItem>

ReactionsListForIssueCommentResponseDataItem

ReactionsListForIssueCommentResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForIssueCommentResponseDataItemUser }

Type declaration

ReactionsListForIssueCommentResponseDataItemUser

ReactionsListForIssueCommentResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsListForIssueEndpoint

ReactionsListForIssueEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to an issue.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForIssueRequestOptions

ReactionsListForIssueRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/reactions" }

Type declaration

ReactionsListForIssueResponseData

ReactionsListForIssueResponseData: Array<ReactionsListForIssueResponseDataItem>

ReactionsListForIssueResponseDataItem

ReactionsListForIssueResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForIssueResponseDataItemUser }

Type declaration

ReactionsListForIssueResponseDataItemUser

ReactionsListForIssueResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsListForPullRequestReviewCommentEndpoint

ReactionsListForPullRequestReviewCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForPullRequestReviewCommentRequestOptions

ReactionsListForPullRequestReviewCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" }

Type declaration

ReactionsListForPullRequestReviewCommentResponseData

ReactionsListForPullRequestReviewCommentResponseData: Array<ReactionsListForPullRequestReviewCommentResponseDataItem>

ReactionsListForPullRequestReviewCommentResponseDataItem

ReactionsListForPullRequestReviewCommentResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForPullRequestReviewCommentResponseDataItemUser }

Type declaration

ReactionsListForPullRequestReviewCommentResponseDataItemUser

ReactionsListForPullRequestReviewCommentResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsListForTeamDiscussionCommentInOrgEndpoint

ReactionsListForTeamDiscussionCommentInOrgEndpoint: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

ReactionsListForTeamDiscussionCommentInOrgRequestOptions

ReactionsListForTeamDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionCommentInOrgResponseData

ReactionsListForTeamDiscussionCommentInOrgResponseData: Array<ReactionsListForTeamDiscussionCommentInOrgResponseDataItem>

ReactionsListForTeamDiscussionCommentInOrgResponseDataItem

ReactionsListForTeamDiscussionCommentInOrgResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser }

Type declaration

ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser

ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsListForTeamDiscussionCommentLegacyEndpoint

ReactionsListForTeamDiscussionCommentLegacyEndpoint: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

ReactionsListForTeamDiscussionCommentLegacyRequestOptions

ReactionsListForTeamDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionCommentLegacyResponseData

ReactionsListForTeamDiscussionCommentLegacyResponseData: Array<ReactionsListForTeamDiscussionCommentLegacyResponseDataItem>

ReactionsListForTeamDiscussionCommentLegacyResponseDataItem

ReactionsListForTeamDiscussionCommentLegacyResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser }

Type declaration

ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser

ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsListForTeamDiscussionInOrgEndpoint

ReactionsListForTeamDiscussionInOrgEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

ReactionsListForTeamDiscussionInOrgRequestOptions

ReactionsListForTeamDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionInOrgResponseData

ReactionsListForTeamDiscussionInOrgResponseData: Array<ReactionsListForTeamDiscussionInOrgResponseDataItem>

ReactionsListForTeamDiscussionInOrgResponseDataItem

ReactionsListForTeamDiscussionInOrgResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionInOrgResponseDataItemUser }

Type declaration

ReactionsListForTeamDiscussionInOrgResponseDataItemUser

ReactionsListForTeamDiscussionInOrgResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReactionsListForTeamDiscussionLegacyEndpoint

ReactionsListForTeamDiscussionLegacyEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

ReactionsListForTeamDiscussionLegacyRequestOptions

ReactionsListForTeamDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionLegacyResponseData

ReactionsListForTeamDiscussionLegacyResponseData: Array<ReactionsListForTeamDiscussionLegacyResponseDataItem>

ReactionsListForTeamDiscussionLegacyResponseDataItem

ReactionsListForTeamDiscussionLegacyResponseDataItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionLegacyResponseDataItemUser }

Type declaration

ReactionsListForTeamDiscussionLegacyResponseDataItemUser

ReactionsListForTeamDiscussionLegacyResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposAcceptInvitationEndpoint

ReposAcceptInvitationEndpoint: { invitation_id: number }

Type declaration

  • invitation_id: number

    invitation_id parameter

ReposAcceptInvitationRequestOptions

ReposAcceptInvitationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user/repository_invitations/:invitation_id" }

Type declaration

ReposAddCollaboratorEndpoint

ReposAddCollaboratorEndpoint: { owner: string; permission?: "pull" | "push" | "admin" | "maintain" | "triage"; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • Optional permission?: "pull" | "push" | "admin" | "maintain" | "triage"

    The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of: * pull - can pull, but not push to or administer this repository. * push - can pull and push, but not administer this repository. * admin - can pull, push and administer this repository. * maintain - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. * triage - Recommended for contributors who need to proactively manage issues and pull requests without write access.

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposAddCollaboratorRequestOptions

ReposAddCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username" }

Type declaration

ReposAddCollaboratorResponseData

ReposAddCollaboratorResponseData: { created_at: string; html_url: string; id: number; invitee: ReposAddCollaboratorResponseDataInvitee; inviter: ReposAddCollaboratorResponseDataInviter; permissions: string; repository: ReposAddCollaboratorResponseDataRepository; url: string }

Type declaration

ReposAddCollaboratorResponseDataInvitee

ReposAddCollaboratorResponseDataInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposAddCollaboratorResponseDataInviter

ReposAddCollaboratorResponseDataInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposAddCollaboratorResponseDataRepository

ReposAddCollaboratorResponseDataRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposAddCollaboratorResponseDataRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ReposAddCollaboratorResponseDataRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposAddCollaboratorResponseDataRepositoryOwner

ReposAddCollaboratorResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposAddDeployKeyEndpoint

ReposAddDeployKeyEndpoint: { key: string; owner: string; read_only?: boolean; repo: string; title?: string }

Type declaration

  • key: string

    The contents of the key.

  • owner: string

    owner parameter

  • Optional read_only?: boolean

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

  • repo: string

    repo parameter

  • Optional title?: string

    A name for the key.

ReposAddDeployKeyRequestOptions

ReposAddDeployKeyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys" }

Type declaration

ReposAddDeployKeyResponseData

ReposAddDeployKeyResponseData: { created_at: string; id: number; key: string; read_only: boolean; title: string; url: string; verified: boolean }

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

ReposAddProtectedBranchAdminEnforcementEndpoint

ReposAddProtectedBranchAdminEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchAdminEnforcementRequestOptions

ReposAddProtectedBranchAdminEnforcementRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" }

Type declaration

ReposAddProtectedBranchAdminEnforcementResponseData

ReposAddProtectedBranchAdminEnforcementResponseData: { enabled: boolean; url: string }

Type declaration

  • enabled: boolean
  • url: string

ReposAddProtectedBranchAppRestrictionsEndpoint

ReposAddProtectedBranchAppRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchAppRestrictionsRequestOptions

ReposAddProtectedBranchAppRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposAddProtectedBranchAppRestrictionsResponseData

ReposAddProtectedBranchAppRestrictionsResponseData: Array<ReposAddProtectedBranchAppRestrictionsResponseDataItem>

ReposAddProtectedBranchAppRestrictionsResponseDataItem

ReposAddProtectedBranchAppRestrictionsResponseDataItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner; permissions: ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions; slug: string; updated_at: string }

Type declaration

ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner

ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions

ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposAddProtectedBranchRequiredSignaturesEndpoint

ReposAddProtectedBranchRequiredSignaturesEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchRequiredSignaturesRequestOptions

ReposAddProtectedBranchRequiredSignaturesRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" }

Type declaration

ReposAddProtectedBranchRequiredSignaturesResponseData

ReposAddProtectedBranchRequiredSignaturesResponseData: { enabled: boolean; url: string }

Type declaration

  • enabled: boolean
  • url: string

ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint

ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • contexts: string[]

    contexts parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposAddProtectedBranchRequiredStatusChecksContextsResponseData

ReposAddProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposAddProtectedBranchTeamRestrictionsEndpoint

ReposAddProtectedBranchTeamRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • teams: string[]

    teams parameter

ReposAddProtectedBranchTeamRestrictionsRequestOptions

ReposAddProtectedBranchTeamRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposAddProtectedBranchTeamRestrictionsResponseData

ReposAddProtectedBranchTeamRestrictionsResponseData: Array<ReposAddProtectedBranchTeamRestrictionsResponseDataItem>

ReposAddProtectedBranchTeamRestrictionsResponseDataItem

ReposAddProtectedBranchTeamRestrictionsResponseDataItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposAddProtectedBranchUserRestrictionsEndpoint

ReposAddProtectedBranchUserRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • users: string[]

    users parameter

ReposAddProtectedBranchUserRestrictionsRequestOptions

ReposAddProtectedBranchUserRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposAddProtectedBranchUserRestrictionsResponseData

ReposAddProtectedBranchUserRestrictionsResponseData: Array<ReposAddProtectedBranchUserRestrictionsResponseDataItem>

ReposAddProtectedBranchUserRestrictionsResponseDataItem

ReposAddProtectedBranchUserRestrictionsResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCheckCollaboratorEndpoint

ReposCheckCollaboratorEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposCheckCollaboratorRequestOptions

ReposCheckCollaboratorRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username" }

Type declaration

ReposCheckVulnerabilityAlertsEndpoint

ReposCheckVulnerabilityAlertsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCheckVulnerabilityAlertsRequestOptions

ReposCheckVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/vulnerability-alerts" }

Type declaration

ReposCompareCommitsEndpoint

ReposCompareCommitsEndpoint: { base: string; head: string; owner: string; repo: string }

Type declaration

  • base: string

    base parameter

  • head: string

    head parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCompareCommitsRequestOptions

ReposCompareCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/compare/:base...:head" }

Type declaration

ReposCompareCommitsResponseData

ReposCompareCommitsResponseData: { ahead_by: number; base_commit: ReposCompareCommitsResponseDataBaseCommit; behind_by: number; commits: Array<ReposCompareCommitsResponseDataCommitsItem>; diff_url: string; files: Array<ReposCompareCommitsResponseDataFilesItem>; html_url: string; merge_base_commit: ReposCompareCommitsResponseDataMergeBaseCommit; patch_url: string; permalink_url: string; status: string; total_commits: number; url: string }

Type declaration

ReposCompareCommitsResponseDataBaseCommit

ReposCompareCommitsResponseDataBaseCommit: { author: ReposCompareCommitsResponseDataBaseCommitAuthor; comments_url: string; commit: ReposCompareCommitsResponseDataBaseCommitCommit; committer: ReposCompareCommitsResponseDataBaseCommitCommitter; html_url: string; node_id: string; parents: Array<ReposCompareCommitsResponseDataBaseCommitParentsItem>; sha: string; url: string }

Type declaration

ReposCompareCommitsResponseDataBaseCommitAuthor

ReposCompareCommitsResponseDataBaseCommitAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCompareCommitsResponseDataBaseCommitCommit

ReposCompareCommitsResponseDataBaseCommitCommit: { author: ReposCompareCommitsResponseDataBaseCommitCommitAuthor; comment_count: number; committer: ReposCompareCommitsResponseDataBaseCommitCommitCommitter; message: string; tree: ReposCompareCommitsResponseDataBaseCommitCommitTree; url: string; verification: ReposCompareCommitsResponseDataBaseCommitCommitVerification }

Type declaration

ReposCompareCommitsResponseDataBaseCommitCommitAuthor

ReposCompareCommitsResponseDataBaseCommitCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCompareCommitsResponseDataBaseCommitCommitCommitter

ReposCompareCommitsResponseDataBaseCommitCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCompareCommitsResponseDataBaseCommitCommitTree

ReposCompareCommitsResponseDataBaseCommitCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseDataBaseCommitCommitVerification

ReposCompareCommitsResponseDataBaseCommitCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposCompareCommitsResponseDataBaseCommitCommitter

ReposCompareCommitsResponseDataBaseCommitCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCompareCommitsResponseDataBaseCommitParentsItem

ReposCompareCommitsResponseDataBaseCommitParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseDataCommitsItem

ReposCompareCommitsResponseDataCommitsItem: { author: ReposCompareCommitsResponseDataCommitsItemAuthor; comments_url: string; commit: ReposCompareCommitsResponseDataCommitsItemCommit; committer: ReposCompareCommitsResponseDataCommitsItemCommitter; html_url: string; node_id: string; parents: Array<ReposCompareCommitsResponseDataCommitsItemParentsItem>; sha: string; url: string }

Type declaration

ReposCompareCommitsResponseDataCommitsItemAuthor

ReposCompareCommitsResponseDataCommitsItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCompareCommitsResponseDataCommitsItemCommit

ReposCompareCommitsResponseDataCommitsItemCommit: { author: ReposCompareCommitsResponseDataCommitsItemCommitAuthor; comment_count: number; committer: ReposCompareCommitsResponseDataCommitsItemCommitCommitter; message: string; tree: ReposCompareCommitsResponseDataCommitsItemCommitTree; url: string; verification: ReposCompareCommitsResponseDataCommitsItemCommitVerification }

Type declaration

ReposCompareCommitsResponseDataCommitsItemCommitAuthor

ReposCompareCommitsResponseDataCommitsItemCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCompareCommitsResponseDataCommitsItemCommitCommitter

ReposCompareCommitsResponseDataCommitsItemCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCompareCommitsResponseDataCommitsItemCommitTree

ReposCompareCommitsResponseDataCommitsItemCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseDataCommitsItemCommitVerification

ReposCompareCommitsResponseDataCommitsItemCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposCompareCommitsResponseDataCommitsItemCommitter

ReposCompareCommitsResponseDataCommitsItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCompareCommitsResponseDataCommitsItemParentsItem

ReposCompareCommitsResponseDataCommitsItemParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseDataFilesItem

ReposCompareCommitsResponseDataFilesItem: { additions: number; blob_url: string; changes: number; contents_url: string; deletions: number; filename: string; patch: string; raw_url: string; sha: string; status: string }

Type declaration

  • additions: number
  • blob_url: string
  • changes: number
  • contents_url: string
  • deletions: number
  • filename: string
  • patch: string
  • raw_url: string
  • sha: string
  • status: string

ReposCompareCommitsResponseDataMergeBaseCommit

ReposCompareCommitsResponseDataMergeBaseCommit: { author: ReposCompareCommitsResponseDataMergeBaseCommitAuthor; comments_url: string; commit: ReposCompareCommitsResponseDataMergeBaseCommitCommit; committer: ReposCompareCommitsResponseDataMergeBaseCommitCommitter; html_url: string; node_id: string; parents: Array<ReposCompareCommitsResponseDataMergeBaseCommitParentsItem>; sha: string; url: string }

Type declaration

ReposCompareCommitsResponseDataMergeBaseCommitAuthor

ReposCompareCommitsResponseDataMergeBaseCommitAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCompareCommitsResponseDataMergeBaseCommitCommit

ReposCompareCommitsResponseDataMergeBaseCommitCommit: { author: ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor; comment_count: number; committer: ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter; message: string; tree: ReposCompareCommitsResponseDataMergeBaseCommitCommitTree; url: string; verification: ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification }

Type declaration

ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor

ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter

ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCompareCommitsResponseDataMergeBaseCommitCommitTree

ReposCompareCommitsResponseDataMergeBaseCommitCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification

ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposCompareCommitsResponseDataMergeBaseCommitCommitter

ReposCompareCommitsResponseDataMergeBaseCommitCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCompareCommitsResponseDataMergeBaseCommitParentsItem

ReposCompareCommitsResponseDataMergeBaseCommitParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposCreateCommitCommentEndpoint

ReposCreateCommitCommentEndpoint: { body: string; commit_sha: string; line?: number; owner: string; path?: string; position?: number; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • commit_sha: string

    commit_sha parameter

  • Optional line?: number

    Deprecated. Use position parameter instead. Line number in the file to comment on.

  • owner: string

    owner parameter

  • Optional path?: string

    Relative path of the file to comment on.

  • Optional position?: number

    Line index in the diff to comment on.

  • repo: string

    repo parameter

ReposCreateCommitCommentRequestOptions

ReposCreateCommitCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/comments" }

Type declaration

ReposCreateCommitCommentResponseData

ReposCreateCommitCommentResponseData: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposCreateCommitCommentResponseDataUser }

Type declaration

  • body: string
  • commit_id: string
  • created_at: string
  • html_url: string
  • id: number
  • line: number
  • node_id: string
  • path: string
  • position: number
  • updated_at: string
  • url: string
  • user: ReposCreateCommitCommentResponseDataUser

ReposCreateCommitCommentResponseDataUser

ReposCreateCommitCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateDeploymentEndpoint

ReposCreateDeploymentEndpoint: { auto_merge?: boolean; description?: string; environment?: string; owner: string; payload?: string; production_environment?: boolean; ref: string; repo: string; required_contexts?: string[]; task?: string; transient_environment?: boolean }

Type declaration

  • Optional auto_merge?: boolean

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

  • Optional description?: string

    Short description of the deployment.

  • Optional environment?: string

    Name for the target deployment environment (e.g., production, staging, qa).

  • owner: string

    owner parameter

  • Optional payload?: string

    JSON payload with extra information about the deployment.

  • Optional production_environment?: boolean

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • ref: string

    The ref to deploy. This can be a branch, tag, or SHA.

  • repo: string

    repo parameter

  • Optional required_contexts?: string[]

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

  • Optional task?: string

    Specifies a task to execute (e.g., deploy or deploy:migrations).

  • Optional transient_environment?: boolean

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

ReposCreateDeploymentRequestOptions

ReposCreateDeploymentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments" }

Type declaration

ReposCreateDeploymentResponseData

ReposCreateDeploymentResponseData: { created_at: string; creator: ReposCreateDeploymentResponseDataCreator; description: string; environment: string; id: number; node_id: string; original_environment: string; payload: ReposCreateDeploymentResponseDataPayload; production_environment: boolean; ref: string; repository_url: string; sha: string; statuses_url: string; task: string; transient_environment: boolean; updated_at: string; url: string }

Type declaration

ReposCreateDeploymentResponseDataCreator

ReposCreateDeploymentResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateDeploymentResponseDataPayload

ReposCreateDeploymentResponseDataPayload: { deploy: string }

Type declaration

  • deploy: string

ReposCreateDeploymentStatusEndpoint

ReposCreateDeploymentStatusEndpoint: { auto_inactive?: boolean; deployment_id: number; description?: string; environment?: "production" | "staging" | "qa"; environment_url?: string; log_url?: string; owner: string; repo: string; state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; target_url?: string }

Type declaration

  • Optional auto_inactive?: boolean

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • deployment_id: number

    deployment_id parameter

  • Optional description?: string

    A short description of the status. The maximum description length is 140 characters.

  • Optional environment?: "production" | "staging" | "qa"

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.

  • Optional environment_url?: string

    Sets the URL for accessing your environment. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • Optional log_url?: string

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"

    The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type.

  • Optional target_url?: string

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

ReposCreateDeploymentStatusRequestOptions

ReposCreateDeploymentStatusRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id/statuses" }

Type declaration

ReposCreateDeploymentStatusResponseData

ReposCreateDeploymentStatusResponseData: { created_at: string; creator: ReposCreateDeploymentStatusResponseDataCreator; deployment_url: string; description: string; environment: string; environment_url: string; id: number; log_url: string; node_id: string; repository_url: string; state: string; target_url: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • creator: ReposCreateDeploymentStatusResponseDataCreator
  • deployment_url: string
  • description: string
  • environment: string
  • environment_url: string
  • id: number
  • log_url: string
  • node_id: string
  • repository_url: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposCreateDeploymentStatusResponseDataCreator

ReposCreateDeploymentStatusResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateDispatchEventEndpoint

ReposCreateDispatchEventEndpoint: { client_payload?: ReposCreateDispatchEventParamsClientPayload; event_type?: string; owner: string; repo: string }

Type declaration

  • Optional client_payload?: ReposCreateDispatchEventParamsClientPayload

    JSON payload with extra information about the webhook event that your action or worklow may use.

  • Optional event_type?: string

    Required: A custom webhook event name.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCreateDispatchEventParamsClientPayload

ReposCreateDispatchEventParamsClientPayload: {}

Type declaration

ReposCreateDispatchEventRequestOptions

ReposCreateDispatchEventRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/dispatches" }

Type declaration

ReposCreateForAuthenticatedUserEndpoint

ReposCreateForAuthenticatedUserEndpoint: { allow_merge_commit?: boolean; allow_rebase_merge?: boolean; allow_squash_merge?: boolean; auto_init?: boolean; delete_branch_on_merge?: boolean; description?: string; gitignore_template?: string; has_issues?: boolean; has_projects?: boolean; has_wiki?: boolean; homepage?: string; is_template?: boolean; license_template?: string; name: string; private?: boolean; team_id?: number; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: boolean

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: boolean

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: boolean

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: boolean

    Pass true to create an initial commit with empty README.

  • Optional delete_branch_on_merge?: boolean

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: string

    A short description of the repository.

  • Optional gitignore_template?: string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: boolean

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: boolean

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: boolean

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: string

    A URL with more information about the repository.

  • Optional is_template?: boolean

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • Optional private?: boolean

    Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

  • Optional team_id?: number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

ReposCreateForAuthenticatedUserRequestOptions

ReposCreateForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/repos" }

Type declaration

ReposCreateForAuthenticatedUserResponseData

ReposCreateForAuthenticatedUserResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateForAuthenticatedUserResponseDataOwner; permissions: ReposCreateForAuthenticatedUserResponseDataPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposCreateForAuthenticatedUserResponseDataOwner
  • permissions: ReposCreateForAuthenticatedUserResponseDataPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposCreateForAuthenticatedUserResponseDataOwner

ReposCreateForAuthenticatedUserResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateForAuthenticatedUserResponseDataPermissions

ReposCreateForAuthenticatedUserResponseDataPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposCreateForkEndpoint

ReposCreateForkEndpoint: { organization?: string; owner: string; repo: string }

Type declaration

  • Optional organization?: string

    Optional parameter to specify the organization name if forking into an organization.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCreateForkRequestOptions

ReposCreateForkRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/forks" }

Type declaration

ReposCreateForkResponseData

ReposCreateForkResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateForkResponseDataOwner; permissions: ReposCreateForkResponseDataPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposCreateForkResponseDataOwner
  • permissions: ReposCreateForkResponseDataPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposCreateForkResponseDataOwner

ReposCreateForkResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateForkResponseDataPermissions

ReposCreateForkResponseDataPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposCreateHookEndpoint

ReposCreateHookEndpoint: { active?: boolean; config: ReposCreateHookParamsConfig; events?: string[]; name?: string; owner: string; repo: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: ReposCreateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • Optional name?: string

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCreateHookParamsConfig

ReposCreateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

ReposCreateHookRequestOptions

ReposCreateHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks" }

Type declaration

ReposCreateHookResponseData

ReposCreateHookResponseData: { active: boolean; config: ReposCreateHookResponseDataConfig; created_at: string; events: Array<string>; id: number; last_response: ReposCreateHookResponseDataLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

Type declaration

ReposCreateHookResponseDataConfig

ReposCreateHookResponseDataConfig: { content_type: string; insecure_ssl: string; url: string }

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposCreateHookResponseDataLastResponse

ReposCreateHookResponseDataLastResponse: { code: null; message: null; status: string }

Type declaration

  • code: null
  • message: null
  • status: string

ReposCreateInOrgEndpoint

ReposCreateInOrgEndpoint: { allow_merge_commit?: boolean; allow_rebase_merge?: boolean; allow_squash_merge?: boolean; auto_init?: boolean; delete_branch_on_merge?: boolean; description?: string; gitignore_template?: string; has_issues?: boolean; has_projects?: boolean; has_wiki?: boolean; homepage?: string; is_template?: boolean; license_template?: string; name: string; org: string; private?: boolean; team_id?: number; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: boolean

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: boolean

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: boolean

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: boolean

    Pass true to create an initial commit with empty README.

  • Optional delete_branch_on_merge?: boolean

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: string

    A short description of the repository.

  • Optional gitignore_template?: string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: boolean

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: boolean

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: boolean

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: string

    A URL with more information about the repository.

  • Optional is_template?: boolean

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • org: string

    org parameter

  • Optional private?: boolean

    Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

  • Optional team_id?: number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

ReposCreateInOrgRequestOptions

ReposCreateInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/repos" }

Type declaration

ReposCreateInOrgResponseData

ReposCreateInOrgResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateInOrgResponseDataOwner; permissions: ReposCreateInOrgResponseDataPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposCreateInOrgResponseDataOwner
  • permissions: ReposCreateInOrgResponseDataPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposCreateInOrgResponseDataOwner

ReposCreateInOrgResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateInOrgResponseDataPermissions

ReposCreateInOrgResponseDataPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposCreateOrUpdateFileEndpoint

ReposCreateOrUpdateFileEndpoint: { author?: ReposCreateOrUpdateFileParamsAuthor; branch?: string; committer?: ReposCreateOrUpdateFileParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: string }

Type declaration

  • Optional author?: ReposCreateOrUpdateFileParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposCreateOrUpdateFileParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string

    owner parameter

  • path: string

    path parameter

  • repo: string

    repo parameter

  • Optional sha?: string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposCreateOrUpdateFileParamsAuthor

ReposCreateOrUpdateFileParamsAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileParamsCommitter

ReposCreateOrUpdateFileParamsCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileRequestOptions

ReposCreateOrUpdateFileRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contents/:path" }

Type declaration

ReposCreateOrUpdateFileResponseData

ReposCreateOrUpdateFileResponseData: { commit: ReposCreateOrUpdateFileResponseDataCommit; content: ReposCreateOrUpdateFileResponseDataContent }

Type declaration

ReposCreateOrUpdateFileResponseDataCommit

ReposCreateOrUpdateFileResponseDataCommit: { author: ReposCreateOrUpdateFileResponseDataCommitAuthor; committer: ReposCreateOrUpdateFileResponseDataCommitCommitter; html_url: string; message: string; node_id: string; parents: Array<ReposCreateOrUpdateFileResponseDataCommitParentsItem>; sha: string; tree: ReposCreateOrUpdateFileResponseDataCommitTree; url: string; verification: ReposCreateOrUpdateFileResponseDataCommitVerification }

Type declaration

ReposCreateOrUpdateFileResponseDataCommitAuthor

ReposCreateOrUpdateFileResponseDataCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCreateOrUpdateFileResponseDataCommitCommitter

ReposCreateOrUpdateFileResponseDataCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposCreateOrUpdateFileResponseDataCommitParentsItem

ReposCreateOrUpdateFileResponseDataCommitParentsItem: { html_url: string; sha: string; url: string }

Type declaration

  • html_url: string
  • sha: string
  • url: string

ReposCreateOrUpdateFileResponseDataCommitTree

ReposCreateOrUpdateFileResponseDataCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposCreateOrUpdateFileResponseDataCommitVerification

ReposCreateOrUpdateFileResponseDataCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposCreateOrUpdateFileResponseDataContent

ReposCreateOrUpdateFileResponseDataContent: { _links: ReposCreateOrUpdateFileResponseDataContentLinks; download_url: string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

Type declaration

ReposCreateOrUpdateFileResponseDataContentLinks

ReposCreateOrUpdateFileResponseDataContentLinks: { git: string; html: string; self: string }

Type declaration

  • git: string
  • html: string
  • self: string

ReposCreateReleaseEndpoint

ReposCreateReleaseEndpoint: { body?: string; draft?: boolean; name?: string; owner: string; prerelease?: boolean; repo: string; tag_name: string; target_commitish?: string }

Type declaration

  • Optional body?: string

    Text describing the contents of the tag.

  • Optional draft?: boolean

    true to create a draft (unpublished) release, false to create a published one.

  • Optional name?: string

    The name of the release.

  • owner: string

    owner parameter

  • Optional prerelease?: boolean

    true to identify the release as a prerelease. false to identify the release as a full release.

  • repo: string

    repo parameter

  • tag_name: string

    The name of the tag.

  • Optional target_commitish?: string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposCreateReleaseRequestOptions

ReposCreateReleaseRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases" }

Type declaration

ReposCreateReleaseResponseData

ReposCreateReleaseResponseData: { assets: Array<any>; assets_url: string; author: ReposCreateReleaseResponseDataAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

Type declaration

  • assets: Array<any>
  • assets_url: string
  • author: ReposCreateReleaseResponseDataAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposCreateReleaseResponseDataAuthor

ReposCreateReleaseResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateStatusEndpoint

ReposCreateStatusEndpoint: { context?: string; description?: string; owner: string; repo: string; sha: string; state: "error" | "failure" | "pending" | "success"; target_url?: string }

Type declaration

  • Optional context?: string

    A string label to differentiate this status from the status of other systems.

  • Optional description?: string

    A short description of the status.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • sha: string

    sha parameter

  • state: "error" | "failure" | "pending" | "success"

    The state of the status. Can be one of error, failure, pending, or success.

  • Optional target_url?: string

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: http://ci.example.com/user/repo/build/sha

ReposCreateStatusRequestOptions

ReposCreateStatusRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/statuses/:sha" }

Type declaration

ReposCreateStatusResponseData

ReposCreateStatusResponseData: { avatar_url: string; context: string; created_at: string; creator: ReposCreateStatusResponseDataCreator; description: string; id: number; node_id: string; state: string; target_url: string; updated_at: string; url: string }

Type declaration

  • avatar_url: string
  • context: string
  • created_at: string
  • creator: ReposCreateStatusResponseDataCreator
  • description: string
  • id: number
  • node_id: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposCreateStatusResponseDataCreator

ReposCreateStatusResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateUsingTemplateEndpoint

ReposCreateUsingTemplateEndpoint: { description?: string; name: string; owner?: string; private?: boolean; template_owner: string; template_repo: string }

Type declaration

  • Optional description?: string

    A short description of the new repository.

  • name: string

    The name of the new repository.

  • Optional owner?: string

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

  • Optional private?: boolean

    Either true to create a new private repository or false to create a new public one.

  • template_owner: string

    template_owner parameter

  • template_repo: string

    template_repo parameter

ReposCreateUsingTemplateRequestOptions

ReposCreateUsingTemplateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:template_owner/:template_repo/generate" }

Type declaration

ReposCreateUsingTemplateResponseData

ReposCreateUsingTemplateResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateUsingTemplateResponseDataOwner; permissions: ReposCreateUsingTemplateResponseDataPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: ReposCreateUsingTemplateResponseDataTemplateRepository; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposCreateUsingTemplateResponseDataOwner
  • permissions: ReposCreateUsingTemplateResponseDataPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: ReposCreateUsingTemplateResponseDataTemplateRepository
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposCreateUsingTemplateResponseDataOwner

ReposCreateUsingTemplateResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateUsingTemplateResponseDataPermissions

ReposCreateUsingTemplateResponseDataPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposCreateUsingTemplateResponseDataTemplateRepository

ReposCreateUsingTemplateResponseDataTemplateRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner; permissions: ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner
  • permissions: ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner

ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions

ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposDeclineInvitationEndpoint

ReposDeclineInvitationEndpoint: { invitation_id: number }

Type declaration

  • invitation_id: number

    invitation_id parameter

ReposDeclineInvitationRequestOptions

ReposDeclineInvitationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/repository_invitations/:invitation_id" }

Type declaration

ReposDeleteCommitCommentEndpoint

ReposDeleteCommitCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteCommitCommentRequestOptions

ReposDeleteCommitCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id" }

Type declaration

ReposDeleteDeploymentEndpoint

ReposDeleteDeploymentEndpoint: { deployment_id: number; owner: string; repo: string }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteDeploymentRequestOptions

ReposDeleteDeploymentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id" }

Type declaration

ReposDeleteDownloadEndpoint

ReposDeleteDownloadEndpoint: { download_id: number; owner: string; repo: string }

Type declaration

  • download_id: number

    download_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteDownloadRequestOptions

ReposDeleteDownloadRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/downloads/:download_id" }

Type declaration

ReposDeleteEndpoint

ReposDeleteEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteFileEndpoint

ReposDeleteFileEndpoint: { author?: ReposDeleteFileParamsAuthor; branch?: string; committer?: ReposDeleteFileParamsCommitter; message: string; owner: string; path: string; repo: string; sha: string }

Type declaration

  • Optional author?: ReposDeleteFileParamsAuthor

    object containing information about the author.

  • Optional branch?: string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposDeleteFileParamsCommitter

    object containing information about the committer.

  • message: string

    The commit message.

  • owner: string

    owner parameter

  • path: string

    path parameter

  • repo: string

    repo parameter

  • sha: string

    The blob SHA of the file being replaced.

ReposDeleteFileParamsAuthor

ReposDeleteFileParamsAuthor: { email?: string; name?: string }

Type declaration

  • Optional email?: string
  • Optional name?: string

ReposDeleteFileParamsCommitter

ReposDeleteFileParamsCommitter: { email?: string; name?: string }

Type declaration

  • Optional email?: string
  • Optional name?: string

ReposDeleteFileRequestOptions

ReposDeleteFileRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contents/:path" }

Type declaration

ReposDeleteFileResponseData

ReposDeleteFileResponseData: { commit: ReposDeleteFileResponseDataCommit; content: null }

Type declaration

ReposDeleteFileResponseDataCommit

ReposDeleteFileResponseDataCommit: { author: ReposDeleteFileResponseDataCommitAuthor; committer: ReposDeleteFileResponseDataCommitCommitter; html_url: string; message: string; node_id: string; parents: Array<ReposDeleteFileResponseDataCommitParentsItem>; sha: string; tree: ReposDeleteFileResponseDataCommitTree; url: string; verification: ReposDeleteFileResponseDataCommitVerification }

Type declaration

ReposDeleteFileResponseDataCommitAuthor

ReposDeleteFileResponseDataCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposDeleteFileResponseDataCommitCommitter

ReposDeleteFileResponseDataCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposDeleteFileResponseDataCommitParentsItem

ReposDeleteFileResponseDataCommitParentsItem: { html_url: string; sha: string; url: string }

Type declaration

  • html_url: string
  • sha: string
  • url: string

ReposDeleteFileResponseDataCommitTree

ReposDeleteFileResponseDataCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposDeleteFileResponseDataCommitVerification

ReposDeleteFileResponseDataCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposDeleteHookEndpoint

ReposDeleteHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteHookRequestOptions

ReposDeleteHookRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id" }

Type declaration

ReposDeleteInvitationEndpoint

ReposDeleteInvitationEndpoint: { invitation_id: number; owner: string; repo: string }

Type declaration

  • invitation_id: number

    invitation_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteInvitationRequestOptions

ReposDeleteInvitationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/invitations/:invitation_id" }

Type declaration

ReposDeleteReleaseAssetEndpoint

ReposDeleteReleaseAssetEndpoint: { asset_id: number; owner: string; repo: string }

Type declaration

  • asset_id: number

    asset_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteReleaseAssetRequestOptions

ReposDeleteReleaseAssetRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/assets/:asset_id" }

Type declaration

ReposDeleteReleaseEndpoint

ReposDeleteReleaseEndpoint: { owner: string; release_id: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposDeleteReleaseRequestOptions

ReposDeleteReleaseRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id" }

Type declaration

ReposDeleteRequestOptions

ReposDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo" }

Type declaration

ReposDeleteResponseData

ReposDeleteResponseData: { documentation_url: string; message: string }

Type declaration

  • documentation_url: string
  • message: string

ReposDisableAutomatedSecurityFixesEndpoint

ReposDisableAutomatedSecurityFixesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDisableAutomatedSecurityFixesRequestOptions

ReposDisableAutomatedSecurityFixesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/automated-security-fixes" }

Type declaration

ReposDisablePagesSiteEndpoint

ReposDisablePagesSiteEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDisablePagesSiteRequestOptions

ReposDisablePagesSiteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposDisableVulnerabilityAlertsEndpoint

ReposDisableVulnerabilityAlertsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDisableVulnerabilityAlertsRequestOptions

ReposDisableVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/vulnerability-alerts" }

Type declaration

ReposEnableAutomatedSecurityFixesEndpoint

ReposEnableAutomatedSecurityFixesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposEnableAutomatedSecurityFixesRequestOptions

ReposEnableAutomatedSecurityFixesRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/automated-security-fixes" }

Type declaration

ReposEnablePagesSiteEndpoint

ReposEnablePagesSiteEndpoint: { owner: string; repo: string; source?: ReposEnablePagesSiteParamsSource }

Type declaration

ReposEnablePagesSiteParamsSource

ReposEnablePagesSiteParamsSource: { branch?: "master" | "gh-pages"; path?: string }

Type declaration

  • Optional branch?: "master" | "gh-pages"
  • Optional path?: string

ReposEnablePagesSiteRequestOptions

ReposEnablePagesSiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposEnablePagesSiteResponseData

ReposEnablePagesSiteResponseData: { cname: string; custom_404: boolean; html_url: string; source: ReposEnablePagesSiteResponseDataSource; status: string; url: string }

Type declaration

ReposEnablePagesSiteResponseDataSource

ReposEnablePagesSiteResponseDataSource: { branch: string; directory: string }

Type declaration

  • branch: string
  • directory: string

ReposEnableVulnerabilityAlertsEndpoint

ReposEnableVulnerabilityAlertsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposEnableVulnerabilityAlertsRequestOptions

ReposEnableVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/vulnerability-alerts" }

Type declaration

ReposGetAllTopicsEndpoint

ReposGetAllTopicsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetAllTopicsRequestOptions

ReposGetAllTopicsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/topics" }

Type declaration

ReposGetAllTopicsResponseData

ReposGetAllTopicsResponseData: { names: Array<string> }

Type declaration

  • names: Array<string>

ReposGetAppsWithAccessToProtectedBranchEndpoint

ReposGetAppsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetAppsWithAccessToProtectedBranchRequestOptions

ReposGetAppsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposGetAppsWithAccessToProtectedBranchResponseData

ReposGetAppsWithAccessToProtectedBranchResponseData: Array<ReposGetAppsWithAccessToProtectedBranchResponseDataItem>

ReposGetAppsWithAccessToProtectedBranchResponseDataItem

ReposGetAppsWithAccessToProtectedBranchResponseDataItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner; permissions: ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions; slug: string; updated_at: string }

Type declaration

ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner

ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions

ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposGetArchiveLinkEndpoint

ReposGetArchiveLinkEndpoint: { archive_format: string; owner: string; ref: string; repo: string }

Type declaration

  • archive_format: string

    archive_format parameter

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposGetArchiveLinkRequestOptions

ReposGetArchiveLinkRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/:archive_format/:ref" }

Type declaration

ReposGetBranchEndpoint

ReposGetBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetBranchProtectionEndpoint

ReposGetBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetBranchProtectionRequestOptions

ReposGetBranchProtectionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection" }

Type declaration

ReposGetBranchProtectionResponseData

ReposGetBranchProtectionResponseData: { allow_deletions: ReposGetBranchProtectionResponseDataAllowDeletions; allow_force_pushes: ReposGetBranchProtectionResponseDataAllowForcePushes; enforce_admins: ReposGetBranchProtectionResponseDataEnforceAdmins; required_linear_history: ReposGetBranchProtectionResponseDataRequiredLinearHistory; required_pull_request_reviews: ReposGetBranchProtectionResponseDataRequiredPullRequestReviews; required_status_checks: ReposGetBranchProtectionResponseDataRequiredStatusChecks; restrictions: ReposGetBranchProtectionResponseDataRestrictions; url: string }

Type declaration

ReposGetBranchProtectionResponseDataAllowDeletions

ReposGetBranchProtectionResponseDataAllowDeletions: { enabled: boolean }

Type declaration

  • enabled: boolean

ReposGetBranchProtectionResponseDataAllowForcePushes

ReposGetBranchProtectionResponseDataAllowForcePushes: { enabled: boolean }

Type declaration

  • enabled: boolean

ReposGetBranchProtectionResponseDataEnforceAdmins

ReposGetBranchProtectionResponseDataEnforceAdmins: { enabled: boolean; url: string }

Type declaration

  • enabled: boolean
  • url: string

ReposGetBranchProtectionResponseDataRequiredLinearHistory

ReposGetBranchProtectionResponseDataRequiredLinearHistory: { enabled: boolean }

Type declaration

  • enabled: boolean

ReposGetBranchProtectionResponseDataRequiredPullRequestReviews

ReposGetBranchProtectionResponseDataRequiredPullRequestReviews: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

Type declaration

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions: { teams: Array<ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem>; users_url: string }

Type declaration

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetBranchProtectionResponseDataRequiredStatusChecks

ReposGetBranchProtectionResponseDataRequiredStatusChecks: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposGetBranchProtectionResponseDataRestrictions

ReposGetBranchProtectionResponseDataRestrictions: { apps: Array<ReposGetBranchProtectionResponseDataRestrictionsAppsItem>; apps_url: string; teams: Array<ReposGetBranchProtectionResponseDataRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposGetBranchProtectionResponseDataRestrictionsUsersItem>; users_url: string }

Type declaration

ReposGetBranchProtectionResponseDataRestrictionsAppsItem

ReposGetBranchProtectionResponseDataRestrictionsAppsItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner; permissions: ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions; slug: string; updated_at: string }

Type declaration

ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner

ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions

ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposGetBranchProtectionResponseDataRestrictionsTeamsItem

ReposGetBranchProtectionResponseDataRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposGetBranchProtectionResponseDataRestrictionsUsersItem

ReposGetBranchProtectionResponseDataRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetBranchRequestOptions

ReposGetBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch" }

Type declaration

ReposGetBranchResponseData

ReposGetBranchResponseData: { _links: ReposGetBranchResponseDataLinks; commit: ReposGetBranchResponseDataCommit; name: string; protected: boolean; protection: ReposGetBranchResponseDataProtection; protection_url: string }

Type declaration

ReposGetBranchResponseDataCommit

ReposGetBranchResponseDataCommit: { author: ReposGetBranchResponseDataCommitAuthor; commit: ReposGetBranchResponseDataCommitCommit; committer: ReposGetBranchResponseDataCommitCommitter; node_id: string; parents: Array<ReposGetBranchResponseDataCommitParentsItem>; sha: string; url: string }

Type declaration

ReposGetBranchResponseDataCommitAuthor

ReposGetBranchResponseDataCommitAuthor: { avatar_url: string; gravatar_id: string; id: number; login: string; url: string }

Type declaration

  • avatar_url: string
  • gravatar_id: string
  • id: number
  • login: string
  • url: string

ReposGetBranchResponseDataCommitCommit

ReposGetBranchResponseDataCommitCommit: { author: ReposGetBranchResponseDataCommitCommitAuthor; committer: ReposGetBranchResponseDataCommitCommitCommitter; message: string; tree: ReposGetBranchResponseDataCommitCommitTree; url: string; verification: ReposGetBranchResponseDataCommitCommitVerification }

Type declaration

ReposGetBranchResponseDataCommitCommitAuthor

ReposGetBranchResponseDataCommitCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposGetBranchResponseDataCommitCommitCommitter

ReposGetBranchResponseDataCommitCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposGetBranchResponseDataCommitCommitTree

ReposGetBranchResponseDataCommitCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposGetBranchResponseDataCommitCommitVerification

ReposGetBranchResponseDataCommitCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposGetBranchResponseDataCommitCommitter

ReposGetBranchResponseDataCommitCommitter: { avatar_url: string; gravatar_id: string; id: number; login: string; url: string }

Type declaration

  • avatar_url: string
  • gravatar_id: string
  • id: number
  • login: string
  • url: string

ReposGetBranchResponseDataCommitParentsItem

ReposGetBranchResponseDataCommitParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposGetBranchResponseDataLinks

ReposGetBranchResponseDataLinks: { html: string; self: string }

Type declaration

  • html: string
  • self: string

ReposGetBranchResponseDataProtection

ReposGetBranchResponseDataProtection: { enabled: boolean; required_status_checks: ReposGetBranchResponseDataProtectionRequiredStatusChecks }

Type declaration

ReposGetBranchResponseDataProtectionRequiredStatusChecks

ReposGetBranchResponseDataProtectionRequiredStatusChecks: { contexts: Array<string>; enforcement_level: string }

Type declaration

  • contexts: Array<string>
  • enforcement_level: string

ReposGetClonesEndpoint

ReposGetClonesEndpoint: { owner: string; per?: "day" | "week"; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

    repo parameter

ReposGetClonesRequestOptions

ReposGetClonesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/clones" }

Type declaration

ReposGetClonesResponseData

ReposGetClonesResponseData: { clones: Array<ReposGetClonesResponseDataClonesItem>; count: number; uniques: number }

Type declaration

ReposGetClonesResponseDataClonesItem

ReposGetClonesResponseDataClonesItem: { count: number; timestamp: string; uniques: number }

Type declaration

  • count: number
  • timestamp: string
  • uniques: number

ReposGetCodeFrequencyStatsEndpoint

ReposGetCodeFrequencyStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetCodeFrequencyStatsRequestOptions

ReposGetCodeFrequencyStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/code_frequency" }

Type declaration

ReposGetCodeFrequencyStatsResponseData

ReposGetCodeFrequencyStatsResponseData: Array<Array<number>>

ReposGetCollaboratorPermissionLevelEndpoint

ReposGetCollaboratorPermissionLevelEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposGetCollaboratorPermissionLevelRequestOptions

ReposGetCollaboratorPermissionLevelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username/permission" }

Type declaration

ReposGetCollaboratorPermissionLevelResponseData

ReposGetCollaboratorPermissionLevelResponseData: { permission: string; user: ReposGetCollaboratorPermissionLevelResponseDataUser }

Type declaration

ReposGetCollaboratorPermissionLevelResponseDataUser

ReposGetCollaboratorPermissionLevelResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetCombinedStatusForRefEndpoint

ReposGetCombinedStatusForRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposGetCombinedStatusForRefRequestOptions

ReposGetCombinedStatusForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/status" }

Type declaration

ReposGetCombinedStatusForRefResponseData

ReposGetCombinedStatusForRefResponseData: { commit_url: string; repository: ReposGetCombinedStatusForRefResponseDataRepository; sha: string; state: string; statuses: Array<ReposGetCombinedStatusForRefResponseDataStatusesItem>; total_count: number; url: string }

Type declaration

ReposGetCombinedStatusForRefResponseDataRepository

ReposGetCombinedStatusForRefResponseDataRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposGetCombinedStatusForRefResponseDataRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ReposGetCombinedStatusForRefResponseDataRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposGetCombinedStatusForRefResponseDataRepositoryOwner

ReposGetCombinedStatusForRefResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetCombinedStatusForRefResponseDataStatusesItem

ReposGetCombinedStatusForRefResponseDataStatusesItem: { avatar_url: string; context: string; created_at: string; description: string; id: number; node_id: string; state: string; target_url: string; updated_at: string; url: string }

Type declaration

  • avatar_url: string
  • context: string
  • created_at: string
  • description: string
  • id: number
  • node_id: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposGetCommitActivityStatsEndpoint

ReposGetCommitActivityStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetCommitActivityStatsRequestOptions

ReposGetCommitActivityStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/commit_activity" }

Type declaration

ReposGetCommitActivityStatsResponseData

ReposGetCommitActivityStatsResponseData: Array<ReposGetCommitActivityStatsResponseDataItem>

ReposGetCommitActivityStatsResponseDataItem

ReposGetCommitActivityStatsResponseDataItem: { days: Array<number>; total: number; week: number }

Type declaration

  • days: Array<number>
  • total: number
  • week: number

ReposGetCommitCommentEndpoint

ReposGetCommitCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetCommitCommentRequestOptions

ReposGetCommitCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id" }

Type declaration

ReposGetCommitCommentResponseData

ReposGetCommitCommentResponseData: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposGetCommitCommentResponseDataUser }

Type declaration

  • body: string
  • commit_id: string
  • created_at: string
  • html_url: string
  • id: number
  • line: number
  • node_id: string
  • path: string
  • position: number
  • updated_at: string
  • url: string
  • user: ReposGetCommitCommentResponseDataUser

ReposGetCommitCommentResponseDataUser

ReposGetCommitCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetCommitEndpoint

ReposGetCommitEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposGetCommitRequestOptions

ReposGetCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref" }

Type declaration

ReposGetCommitResponseData

ReposGetCommitResponseData: { author: ReposGetCommitResponseDataAuthor; comments_url: string; commit: ReposGetCommitResponseDataCommit; committer: ReposGetCommitResponseDataCommitter; files: Array<ReposGetCommitResponseDataFilesItem>; html_url: string; node_id: string; parents: Array<ReposGetCommitResponseDataParentsItem>; sha: string; stats: ReposGetCommitResponseDataStats; url: string }

Type declaration

ReposGetCommitResponseDataAuthor

ReposGetCommitResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetCommitResponseDataCommit

ReposGetCommitResponseDataCommit: { author: ReposGetCommitResponseDataCommitAuthor; comment_count: number; committer: ReposGetCommitResponseDataCommitCommitter; message: string; tree: ReposGetCommitResponseDataCommitTree; url: string; verification: ReposGetCommitResponseDataCommitVerification }

Type declaration

ReposGetCommitResponseDataCommitAuthor

ReposGetCommitResponseDataCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposGetCommitResponseDataCommitCommitter

ReposGetCommitResponseDataCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposGetCommitResponseDataCommitTree

ReposGetCommitResponseDataCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposGetCommitResponseDataCommitVerification

ReposGetCommitResponseDataCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposGetCommitResponseDataCommitter

ReposGetCommitResponseDataCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetCommitResponseDataFilesItem

ReposGetCommitResponseDataFilesItem: { additions: number; blob_url: string; changes: number; deletions: number; filename: string; patch: string; raw_url: string; status: string }

Type declaration

  • additions: number
  • blob_url: string
  • changes: number
  • deletions: number
  • filename: string
  • patch: string
  • raw_url: string
  • status: string

ReposGetCommitResponseDataParentsItem

ReposGetCommitResponseDataParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposGetCommitResponseDataStats

ReposGetCommitResponseDataStats: { additions: number; deletions: number; total: number }

Type declaration

  • additions: number
  • deletions: number
  • total: number

ReposGetContentsEndpoint

ReposGetContentsEndpoint: { owner: string; path: string; ref?: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • path: string

    path parameter

  • Optional ref?: string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

    repo parameter

ReposGetContentsRequestOptions

ReposGetContentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contents/:path" }

Type declaration

ReposGetContentsResponseData

ReposGetContentsResponseData: { _links: ReposGetContentsResponseDataLinks; content?: string; download_url: string | null; encoding?: string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; submodule_git_url?: string; target?: string; type: string; url: string } | Array<ReposGetContentsResponseDataItem>

ReposGetContentsResponseDataItem

ReposGetContentsResponseDataItem: { _links: ReposGetContentsResponseDataItemLinks; download_url: string | null; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

Type declaration

ReposGetContentsResponseDataItemLinks

ReposGetContentsResponseDataItemLinks: { git: string; html: string; self: string }

Type declaration

  • git: string
  • html: string
  • self: string

ReposGetContentsResponseDataLinks

ReposGetContentsResponseDataLinks: { git: string; html: string; self: string }

Type declaration

  • git: string
  • html: string
  • self: string

ReposGetContributorsStatsEndpoint

ReposGetContributorsStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetContributorsStatsRequestOptions

ReposGetContributorsStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/contributors" }

Type declaration

ReposGetContributorsStatsResponseData

ReposGetContributorsStatsResponseData: Array<ReposGetContributorsStatsResponseDataItem>

ReposGetContributorsStatsResponseDataItem

ReposGetContributorsStatsResponseDataItem: { author: ReposGetContributorsStatsResponseDataItemAuthor; total: number; weeks: Array<ReposGetContributorsStatsResponseDataItemWeeksItem> }

Type declaration

ReposGetContributorsStatsResponseDataItemAuthor

ReposGetContributorsStatsResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetContributorsStatsResponseDataItemWeeksItem

ReposGetContributorsStatsResponseDataItemWeeksItem: { a: number; c: number; d: number; w: string }

Type declaration

  • a: number
  • c: number
  • d: number
  • w: string

ReposGetDeployKeyEndpoint

ReposGetDeployKeyEndpoint: { key_id: number; owner: string; repo: string }

Type declaration

  • key_id: number

    key_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetDeployKeyRequestOptions

ReposGetDeployKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys/:key_id" }

Type declaration

ReposGetDeployKeyResponseData

ReposGetDeployKeyResponseData: { created_at: string; id: number; key: string; read_only: boolean; title: string; url: string; verified: boolean }

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

ReposGetDeploymentEndpoint

ReposGetDeploymentEndpoint: { deployment_id: number; owner: string; repo: string }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetDeploymentRequestOptions

ReposGetDeploymentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id" }

Type declaration

ReposGetDeploymentResponseData

ReposGetDeploymentResponseData: { created_at: string; creator: ReposGetDeploymentResponseDataCreator; description: string; environment: string; id: number; node_id: string; original_environment: string; payload: ReposGetDeploymentResponseDataPayload; production_environment: boolean; ref: string; repository_url: string; sha: string; statuses_url: string; task: string; transient_environment: boolean; updated_at: string; url: string }

Type declaration

  • created_at: string
  • creator: ReposGetDeploymentResponseDataCreator
  • description: string
  • environment: string
  • id: number
  • node_id: string
  • original_environment: string
  • payload: ReposGetDeploymentResponseDataPayload
  • production_environment: boolean
  • ref: string
  • repository_url: string
  • sha: string
  • statuses_url: string
  • task: string
  • transient_environment: boolean
  • updated_at: string
  • url: string

ReposGetDeploymentResponseDataCreator

ReposGetDeploymentResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetDeploymentResponseDataPayload

ReposGetDeploymentResponseDataPayload: { deploy: string }

Type declaration

  • deploy: string

ReposGetDeploymentStatusEndpoint

ReposGetDeploymentStatusEndpoint: { deployment_id: number; owner: string; repo: string; status_id: number }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • status_id: number

    status_id parameter

ReposGetDeploymentStatusRequestOptions

ReposGetDeploymentStatusRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id" }

Type declaration

ReposGetDeploymentStatusResponseData

ReposGetDeploymentStatusResponseData: { created_at: string; creator: ReposGetDeploymentStatusResponseDataCreator; deployment_url: string; description: string; environment: string; environment_url: string; id: number; log_url: string; node_id: string; repository_url: string; state: string; target_url: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • creator: ReposGetDeploymentStatusResponseDataCreator
  • deployment_url: string
  • description: string
  • environment: string
  • environment_url: string
  • id: number
  • log_url: string
  • node_id: string
  • repository_url: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposGetDeploymentStatusResponseDataCreator

ReposGetDeploymentStatusResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetDownloadEndpoint

ReposGetDownloadEndpoint: { download_id: number; owner: string; repo: string }

Type declaration

  • download_id: number

    download_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetDownloadRequestOptions

ReposGetDownloadRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/downloads/:download_id" }

Type declaration

ReposGetDownloadResponseData

ReposGetDownloadResponseData: { content_type: string; description: string; download_count: number; html_url: string; id: number; name: string; size: number; url: string }

Type declaration

  • content_type: string
  • description: string
  • download_count: number
  • html_url: string
  • id: number
  • name: string
  • size: number
  • url: string

ReposGetEndpoint

ReposGetEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetHookEndpoint

ReposGetHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetHookRequestOptions

ReposGetHookRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id" }

Type declaration

ReposGetHookResponseData

ReposGetHookResponseData: { active: boolean; config: ReposGetHookResponseDataConfig; created_at: string; events: Array<string>; id: number; last_response: ReposGetHookResponseDataLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

Type declaration

ReposGetHookResponseDataConfig

ReposGetHookResponseDataConfig: { content_type: string; insecure_ssl: string; url: string }

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposGetHookResponseDataLastResponse

ReposGetHookResponseDataLastResponse: { code: null; message: null; status: string }

Type declaration

  • code: null
  • message: null
  • status: string

ReposGetLatestPagesBuildEndpoint

ReposGetLatestPagesBuildEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetLatestPagesBuildRequestOptions

ReposGetLatestPagesBuildRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds/latest" }

Type declaration

ReposGetLatestPagesBuildResponseData

ReposGetLatestPagesBuildResponseData: { commit: string; created_at: string; duration: number; error: ReposGetLatestPagesBuildResponseDataError; pusher: ReposGetLatestPagesBuildResponseDataPusher; status: string; updated_at: string; url: string }

Type declaration

ReposGetLatestPagesBuildResponseDataError

ReposGetLatestPagesBuildResponseDataError: { message: null }

Type declaration

  • message: null

ReposGetLatestPagesBuildResponseDataPusher

ReposGetLatestPagesBuildResponseDataPusher: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetLatestReleaseEndpoint

ReposGetLatestReleaseEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetLatestReleaseRequestOptions

ReposGetLatestReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/latest" }

Type declaration

ReposGetLatestReleaseResponseData

ReposGetLatestReleaseResponseData: { assets: Array<ReposGetLatestReleaseResponseDataAssetsItem>; assets_url: string; author: ReposGetLatestReleaseResponseDataAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

Type declaration

ReposGetLatestReleaseResponseDataAssetsItem

ReposGetLatestReleaseResponseDataAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetLatestReleaseResponseDataAssetsItemUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposGetLatestReleaseResponseDataAssetsItemUploader
  • url: string

ReposGetLatestReleaseResponseDataAssetsItemUploader

ReposGetLatestReleaseResponseDataAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetLatestReleaseResponseDataAuthor

ReposGetLatestReleaseResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetPagesBuildEndpoint

ReposGetPagesBuildEndpoint: { build_id: number; owner: string; repo: string }

Type declaration

  • build_id: number

    build_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetPagesBuildRequestOptions

ReposGetPagesBuildRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds/:build_id" }

Type declaration

ReposGetPagesBuildResponseData

ReposGetPagesBuildResponseData: { commit: string; created_at: string; duration: number; error: ReposGetPagesBuildResponseDataError; pusher: ReposGetPagesBuildResponseDataPusher; status: string; updated_at: string; url: string }

Type declaration

ReposGetPagesBuildResponseDataError

ReposGetPagesBuildResponseDataError: { message: null }

Type declaration

  • message: null

ReposGetPagesBuildResponseDataPusher

ReposGetPagesBuildResponseDataPusher: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetPagesEndpoint

ReposGetPagesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetPagesRequestOptions

ReposGetPagesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposGetPagesResponseData

ReposGetPagesResponseData: { cname: string; custom_404: boolean; html_url: string; source: ReposGetPagesResponseDataSource; status: string; url: string }

Type declaration

ReposGetPagesResponseDataSource

ReposGetPagesResponseDataSource: { branch: string; directory: string }

Type declaration

  • branch: string
  • directory: string

ReposGetParticipationStatsEndpoint

ReposGetParticipationStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetParticipationStatsRequestOptions

ReposGetParticipationStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/participation" }

Type declaration

ReposGetParticipationStatsResponseData

ReposGetParticipationStatsResponseData: { all: Array<number>; owner: Array<number> }

Type declaration

  • all: Array<number>
  • owner: Array<number>

ReposGetProtectedBranchAdminEnforcementEndpoint

ReposGetProtectedBranchAdminEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchAdminEnforcementRequestOptions

ReposGetProtectedBranchAdminEnforcementRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" }

Type declaration

ReposGetProtectedBranchAdminEnforcementResponseData

ReposGetProtectedBranchAdminEnforcementResponseData: { enabled: boolean; url: string }

Type declaration

  • enabled: boolean
  • url: string

ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint

ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" }

Type declaration

ReposGetProtectedBranchPullRequestReviewEnforcementResponseData

ReposGetProtectedBranchPullRequestReviewEnforcementResponseData: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

Type declaration

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions: { teams: Array<ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem>; users_url: string }

Type declaration

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetProtectedBranchRequiredSignaturesEndpoint

ReposGetProtectedBranchRequiredSignaturesEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchRequiredSignaturesRequestOptions

ReposGetProtectedBranchRequiredSignaturesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" }

Type declaration

ReposGetProtectedBranchRequiredSignaturesResponseData

ReposGetProtectedBranchRequiredSignaturesResponseData: { enabled: boolean; url: string }

Type declaration

  • enabled: boolean
  • url: string

ReposGetProtectedBranchRequiredStatusChecksEndpoint

ReposGetProtectedBranchRequiredStatusChecksEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchRequiredStatusChecksRequestOptions

ReposGetProtectedBranchRequiredStatusChecksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" }

Type declaration

ReposGetProtectedBranchRequiredStatusChecksResponseData

ReposGetProtectedBranchRequiredStatusChecksResponseData: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposGetProtectedBranchRestrictionsEndpoint

ReposGetProtectedBranchRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchRestrictionsRequestOptions

ReposGetProtectedBranchRestrictionsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions" }

Type declaration

ReposGetProtectedBranchRestrictionsResponseData

ReposGetProtectedBranchRestrictionsResponseData: { apps: Array<ReposGetProtectedBranchRestrictionsResponseDataAppsItem>; apps_url: string; teams: Array<ReposGetProtectedBranchRestrictionsResponseDataTeamsItem>; teams_url: string; url: string; users: Array<ReposGetProtectedBranchRestrictionsResponseDataUsersItem>; users_url: string }

Type declaration

ReposGetProtectedBranchRestrictionsResponseDataAppsItem

ReposGetProtectedBranchRestrictionsResponseDataAppsItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner; permissions: ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions; slug: string; updated_at: string }

Type declaration

ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner

ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions

ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposGetProtectedBranchRestrictionsResponseDataTeamsItem

ReposGetProtectedBranchRestrictionsResponseDataTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposGetProtectedBranchRestrictionsResponseDataUsersItem

ReposGetProtectedBranchRestrictionsResponseDataUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetPunchCardStatsEndpoint

ReposGetPunchCardStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetPunchCardStatsRequestOptions

ReposGetPunchCardStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/punch_card" }

Type declaration

ReposGetPunchCardStatsResponseData

ReposGetPunchCardStatsResponseData: Array<Array<number>>

ReposGetReadmeEndpoint

ReposGetReadmeEndpoint: { owner: string; ref?: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional ref?: string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

    repo parameter

ReposGetReadmeRequestOptions

ReposGetReadmeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/readme" }

Type declaration

ReposGetReadmeResponseData

ReposGetReadmeResponseData: { _links: ReposGetReadmeResponseDataLinks; content: string; download_url: string; encoding: string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

Type declaration

  • _links: ReposGetReadmeResponseDataLinks
  • content: string
  • download_url: string
  • encoding: string
  • git_url: string
  • html_url: string
  • name: string
  • path: string
  • sha: string
  • size: number
  • type: string
  • url: string

ReposGetReadmeResponseDataLinks

ReposGetReadmeResponseDataLinks: { git: string; html: string; self: string }

Type declaration

  • git: string
  • html: string
  • self: string

ReposGetReleaseAssetEndpoint

ReposGetReleaseAssetEndpoint: { asset_id: number; owner: string; repo: string }

Type declaration

  • asset_id: number

    asset_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetReleaseAssetRequestOptions

ReposGetReleaseAssetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/assets/:asset_id" }

Type declaration

ReposGetReleaseAssetResponseData

ReposGetReleaseAssetResponseData: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetReleaseAssetResponseDataUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposGetReleaseAssetResponseDataUploader
  • url: string

ReposGetReleaseAssetResponseDataUploader

ReposGetReleaseAssetResponseDataUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetReleaseByTagEndpoint

ReposGetReleaseByTagEndpoint: { owner: string; repo: string; tag: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tag: string

    tag parameter

ReposGetReleaseByTagRequestOptions

ReposGetReleaseByTagRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/tags/:tag" }

Type declaration

ReposGetReleaseByTagResponseData

ReposGetReleaseByTagResponseData: { assets: Array<ReposGetReleaseByTagResponseDataAssetsItem>; assets_url: string; author: ReposGetReleaseByTagResponseDataAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

Type declaration

ReposGetReleaseByTagResponseDataAssetsItem

ReposGetReleaseByTagResponseDataAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetReleaseByTagResponseDataAssetsItemUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposGetReleaseByTagResponseDataAssetsItemUploader
  • url: string

ReposGetReleaseByTagResponseDataAssetsItemUploader

ReposGetReleaseByTagResponseDataAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetReleaseByTagResponseDataAuthor

ReposGetReleaseByTagResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetReleaseEndpoint

ReposGetReleaseEndpoint: { owner: string; release_id: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposGetReleaseRequestOptions

ReposGetReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id" }

Type declaration

ReposGetReleaseResponseData

ReposGetReleaseResponseData: { assets: Array<ReposGetReleaseResponseDataAssetsItem>; assets_url: string; author: ReposGetReleaseResponseDataAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

Type declaration

  • assets: Array<ReposGetReleaseResponseDataAssetsItem>
  • assets_url: string
  • author: ReposGetReleaseResponseDataAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposGetReleaseResponseDataAssetsItem

ReposGetReleaseResponseDataAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetReleaseResponseDataAssetsItemUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposGetReleaseResponseDataAssetsItemUploader
  • url: string

ReposGetReleaseResponseDataAssetsItemUploader

ReposGetReleaseResponseDataAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetReleaseResponseDataAuthor

ReposGetReleaseResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetRequestOptions

ReposGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo" }

Type declaration

ReposGetResponseData

ReposGetResponseData: { allow_merge_commit?: boolean; allow_rebase_merge?: boolean; allow_squash_merge?: boolean; archive_url: string; archived?: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; code_of_conduct?: ReposGetResponseDataCodeOfConduct; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string | null; disabled?: boolean; downloads_url: string; events_url: string; fork: boolean; forks?: number; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string | null; hooks_url: string; html_url: string; id: number; is_template?: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license?: ReposGetResponseDataLicense; merges_url: string; milestones_url: string; mirror_url: string | null; name: string; network_count: number; node_id: string; notifications_url: string; open_issues?: number; open_issues_count: number; organization?: ReposGetResponseDataOrganization; owner: ReposGetResponseDataOwner; parent?: ReposGetResponseDataParent; permissions?: ReposGetResponseDataPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; source?: ReposGetResponseDataSource; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token?: string; template_repository?: null; topics?: Array<string>; trees_url: string; updated_at: string; url: string; visibility?: string; watchers?: number; watchers_count: number }

Type declaration

  • Optional allow_merge_commit?: boolean
  • Optional allow_rebase_merge?: boolean
  • Optional allow_squash_merge?: boolean
  • archive_url: string
  • Optional archived?: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • Optional code_of_conduct?: ReposGetResponseDataCodeOfConduct
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string | null
  • Optional disabled?: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • Optional forks?: number
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string | null
  • hooks_url: string
  • html_url: string
  • id: number
  • Optional is_template?: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • Optional license?: ReposGetResponseDataLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string | null
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • Optional open_issues?: number
  • open_issues_count: number
  • Optional organization?: ReposGetResponseDataOrganization
  • owner: ReposGetResponseDataOwner
  • Optional parent?: ReposGetResponseDataParent
  • Optional permissions?: ReposGetResponseDataPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • Optional source?: ReposGetResponseDataSource
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • Optional temp_clone_token?: string
  • Optional template_repository?: null
  • Optional topics?: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • Optional visibility?: string
  • Optional watchers?: number
  • watchers_count: number

ReposGetResponseDataCodeOfConduct

ReposGetResponseDataCodeOfConduct: { key: string; name: string; url: string }

Type declaration

  • key: string
  • name: string
  • url: string

ReposGetResponseDataLicense

ReposGetResponseDataLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ReposGetResponseDataOrganization

ReposGetResponseDataOrganization: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetResponseDataOwner

ReposGetResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetResponseDataParent

ReposGetResponseDataParent: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposGetResponseDataParentOwner; permissions: ReposGetResponseDataParentPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposGetResponseDataParentOwner
  • permissions: ReposGetResponseDataParentPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposGetResponseDataParentOwner

ReposGetResponseDataParentOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetResponseDataParentPermissions

ReposGetResponseDataParentPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposGetResponseDataPermissions

ReposGetResponseDataPermissions: { admin: boolean; maintain: boolean; pull: boolean; push: boolean; triage: boolean }

Type declaration

  • admin: boolean
  • maintain: boolean
  • pull: boolean
  • push: boolean
  • triage: boolean

ReposGetResponseDataSource

ReposGetResponseDataSource: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposGetResponseDataSourceOwner; permissions: ReposGetResponseDataSourcePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposGetResponseDataSourceOwner
  • permissions: ReposGetResponseDataSourcePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposGetResponseDataSourceOwner

ReposGetResponseDataSourceOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetResponseDataSourcePermissions

ReposGetResponseDataSourcePermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposGetTeamsWithAccessToProtectedBranchEndpoint

ReposGetTeamsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetTeamsWithAccessToProtectedBranchRequestOptions

ReposGetTeamsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposGetTeamsWithAccessToProtectedBranchResponseData

ReposGetTeamsWithAccessToProtectedBranchResponseData: Array<ReposGetTeamsWithAccessToProtectedBranchResponseDataItem>

ReposGetTeamsWithAccessToProtectedBranchResponseDataItem

ReposGetTeamsWithAccessToProtectedBranchResponseDataItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposGetTopPathsEndpoint

ReposGetTopPathsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetTopPathsRequestOptions

ReposGetTopPathsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/popular/paths" }

Type declaration

ReposGetTopPathsResponseData

ReposGetTopPathsResponseData: Array<ReposGetTopPathsResponseDataItem>

ReposGetTopPathsResponseDataItem

ReposGetTopPathsResponseDataItem: { count: number; path: string; title: string; uniques: number }

Type declaration

  • count: number
  • path: string
  • title: string
  • uniques: number

ReposGetTopReferrersEndpoint

ReposGetTopReferrersEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetTopReferrersRequestOptions

ReposGetTopReferrersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/popular/referrers" }

Type declaration

ReposGetTopReferrersResponseData

ReposGetTopReferrersResponseData: Array<ReposGetTopReferrersResponseDataItem>

ReposGetTopReferrersResponseDataItem

ReposGetTopReferrersResponseDataItem: { count: number; referrer: string; uniques: number }

Type declaration

  • count: number
  • referrer: string
  • uniques: number

ReposGetUsersWithAccessToProtectedBranchEndpoint

ReposGetUsersWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetUsersWithAccessToProtectedBranchRequestOptions

ReposGetUsersWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposGetUsersWithAccessToProtectedBranchResponseData

ReposGetUsersWithAccessToProtectedBranchResponseData: Array<ReposGetUsersWithAccessToProtectedBranchResponseDataItem>

ReposGetUsersWithAccessToProtectedBranchResponseDataItem

ReposGetUsersWithAccessToProtectedBranchResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposGetViewsEndpoint

ReposGetViewsEndpoint: { owner: string; per?: "day" | "week"; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

    repo parameter

ReposGetViewsRequestOptions

ReposGetViewsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/views" }

Type declaration

ReposGetViewsResponseData

ReposGetViewsResponseData: { count: number; uniques: number; views: Array<ReposGetViewsResponseDataViewsItem> }

Type declaration

ReposGetViewsResponseDataViewsItem

ReposGetViewsResponseDataViewsItem: { count: number; timestamp: string; uniques: number }

Type declaration

  • count: number
  • timestamp: string
  • uniques: number

ReposListAssetsForReleaseEndpoint

ReposListAssetsForReleaseEndpoint: { owner: string; page?: number; per_page?: number; release_id: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposListAssetsForReleaseRequestOptions

ReposListAssetsForReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id/assets" }

Type declaration

ReposListAssetsForReleaseResponseData

ReposListAssetsForReleaseResponseData: Array<ReposListAssetsForReleaseResponseDataItem>

ReposListAssetsForReleaseResponseDataItem

ReposListAssetsForReleaseResponseDataItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposListAssetsForReleaseResponseDataItemUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposListAssetsForReleaseResponseDataItemUploader
  • url: string

ReposListAssetsForReleaseResponseDataItemUploader

ReposListAssetsForReleaseResponseDataItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListBranchesEndpoint

ReposListBranchesEndpoint: { owner: string; page?: number; per_page?: number; protected?: boolean; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional protected?: boolean

    Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

  • repo: string

    repo parameter

ReposListBranchesForHeadCommitEndpoint

ReposListBranchesForHeadCommitEndpoint: { commit_sha: string; owner: string; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListBranchesForHeadCommitRequestOptions

ReposListBranchesForHeadCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head" }

Type declaration

ReposListBranchesForHeadCommitResponseData

ReposListBranchesForHeadCommitResponseData: Array<ReposListBranchesForHeadCommitResponseDataItem>

ReposListBranchesForHeadCommitResponseDataItem

ReposListBranchesForHeadCommitResponseDataItem: { commit: ReposListBranchesForHeadCommitResponseDataItemCommit; name: string; protected: string }

Type declaration

ReposListBranchesForHeadCommitResponseDataItemCommit

ReposListBranchesForHeadCommitResponseDataItemCommit: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposListBranchesRequestOptions

ReposListBranchesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches" }

Type declaration

ReposListBranchesResponseData

ReposListBranchesResponseData: Array<ReposListBranchesResponseDataItem>

ReposListBranchesResponseDataItem

ReposListBranchesResponseDataItem: { commit: ReposListBranchesResponseDataItemCommit; name: string; protected: boolean; protection: ReposListBranchesResponseDataItemProtection; protection_url: string }

Type declaration

ReposListBranchesResponseDataItemCommit

ReposListBranchesResponseDataItemCommit: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposListBranchesResponseDataItemProtection

ReposListBranchesResponseDataItemProtection: { enabled: boolean; required_status_checks: ReposListBranchesResponseDataItemProtectionRequiredStatusChecks }

Type declaration

ReposListBranchesResponseDataItemProtectionRequiredStatusChecks

ReposListBranchesResponseDataItemProtectionRequiredStatusChecks: { contexts: Array<string>; enforcement_level: string }

Type declaration

  • contexts: Array<string>
  • enforcement_level: string

ReposListCollaboratorsEndpoint

ReposListCollaboratorsEndpoint: { affiliation?: "outside" | "direct" | "all"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • Optional affiliation?: "outside" | "direct" | "all"

    Filter collaborators returned by their affiliation. Can be one of: * outside: All outside collaborators of an organization-owned repository. * direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * all: All collaborators the authenticated user can see.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListCollaboratorsRequestOptions

ReposListCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators" }

Type declaration

ReposListCollaboratorsResponseData

ReposListCollaboratorsResponseData: Array<ReposListCollaboratorsResponseDataItem>

ReposListCollaboratorsResponseDataItem

ReposListCollaboratorsResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; permissions: ReposListCollaboratorsResponseDataItemPermissions; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • permissions: ReposListCollaboratorsResponseDataItemPermissions
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCollaboratorsResponseDataItemPermissions

ReposListCollaboratorsResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListCommentsForCommitEndpoint

ReposListCommentsForCommitEndpoint: { commit_sha: string; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListCommentsForCommitRequestOptions

ReposListCommentsForCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/comments" }

Type declaration

ReposListCommentsForCommitResponseData

ReposListCommentsForCommitResponseData: Array<ReposListCommentsForCommitResponseDataItem>

ReposListCommentsForCommitResponseDataItem

ReposListCommentsForCommitResponseDataItem: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposListCommentsForCommitResponseDataItemUser }

Type declaration

ReposListCommentsForCommitResponseDataItemUser

ReposListCommentsForCommitResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitCommentsEndpoint

ReposListCommitCommentsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListCommitCommentsRequestOptions

ReposListCommitCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments" }

Type declaration

ReposListCommitCommentsResponseData

ReposListCommitCommentsResponseData: Array<ReposListCommitCommentsResponseDataItem>

ReposListCommitCommentsResponseDataItem

ReposListCommitCommentsResponseDataItem: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposListCommitCommentsResponseDataItemUser }

Type declaration

  • body: string
  • commit_id: string
  • created_at: string
  • html_url: string
  • id: number
  • line: number
  • node_id: string
  • path: string
  • position: number
  • updated_at: string
  • url: string
  • user: ReposListCommitCommentsResponseDataItemUser

ReposListCommitCommentsResponseDataItemUser

ReposListCommitCommentsResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitsEndpoint

ReposListCommitsEndpoint: { author?: string; owner: string; page?: number; path?: string; per_page?: number; repo: string; sha?: string; since?: string; until?: string }

Type declaration

  • Optional author?: string

    GitHub login or email address by which to filter by commit author.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional path?: string

    Only commits containing this file path will be returned.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sha?: string

    SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).

  • Optional since?: string

    Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional until?: string

    Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ReposListCommitsRequestOptions

ReposListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits" }

Type declaration

ReposListCommitsResponseData

ReposListCommitsResponseData: Array<ReposListCommitsResponseDataItem>

ReposListCommitsResponseDataItem

ReposListCommitsResponseDataItem: { author: ReposListCommitsResponseDataItemAuthor; comments_url: string; commit: ReposListCommitsResponseDataItemCommit; committer: ReposListCommitsResponseDataItemCommitter; html_url: string; node_id: string; parents: Array<ReposListCommitsResponseDataItemParentsItem>; sha: string; url: string }

Type declaration

ReposListCommitsResponseDataItemAuthor

ReposListCommitsResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitsResponseDataItemCommit

ReposListCommitsResponseDataItemCommit: { author: ReposListCommitsResponseDataItemCommitAuthor; comment_count: number; committer: ReposListCommitsResponseDataItemCommitCommitter; message: string; tree: ReposListCommitsResponseDataItemCommitTree; url: string; verification: ReposListCommitsResponseDataItemCommitVerification }

Type declaration

ReposListCommitsResponseDataItemCommitAuthor

ReposListCommitsResponseDataItemCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposListCommitsResponseDataItemCommitCommitter

ReposListCommitsResponseDataItemCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposListCommitsResponseDataItemCommitTree

ReposListCommitsResponseDataItemCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposListCommitsResponseDataItemCommitVerification

ReposListCommitsResponseDataItemCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposListCommitsResponseDataItemCommitter

ReposListCommitsResponseDataItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitsResponseDataItemParentsItem

ReposListCommitsResponseDataItemParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposListContributorsEndpoint

ReposListContributorsEndpoint: { anon?: string; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • Optional anon?: string

    Set to 1 or true to include anonymous contributors in results.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListContributorsRequestOptions

ReposListContributorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contributors" }

Type declaration

ReposListContributorsResponseData

ReposListContributorsResponseData: Array<ReposListContributorsResponseDataItem>

ReposListContributorsResponseDataItem

ReposListContributorsResponseDataItem: { avatar_url: string; contributions: number; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • contributions: number
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListDeployKeysEndpoint

ReposListDeployKeysEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListDeployKeysRequestOptions

ReposListDeployKeysRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys" }

Type declaration

ReposListDeployKeysResponseData

ReposListDeployKeysResponseData: Array<ReposListDeployKeysResponseDataItem>

ReposListDeployKeysResponseDataItem

ReposListDeployKeysResponseDataItem: { created_at: string; id: number; key: string; read_only: boolean; title: string; url: string; verified: boolean }

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

ReposListDeploymentStatusesEndpoint

ReposListDeploymentStatusesEndpoint: { deployment_id: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListDeploymentStatusesRequestOptions

ReposListDeploymentStatusesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id/statuses" }

Type declaration

ReposListDeploymentStatusesResponseData

ReposListDeploymentStatusesResponseData: Array<ReposListDeploymentStatusesResponseDataItem>

ReposListDeploymentStatusesResponseDataItem

ReposListDeploymentStatusesResponseDataItem: { created_at: string; creator: ReposListDeploymentStatusesResponseDataItemCreator; deployment_url: string; description: string; environment: string; environment_url: string; id: number; log_url: string; node_id: string; repository_url: string; state: string; target_url: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • creator: ReposListDeploymentStatusesResponseDataItemCreator
  • deployment_url: string
  • description: string
  • environment: string
  • environment_url: string
  • id: number
  • log_url: string
  • node_id: string
  • repository_url: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposListDeploymentStatusesResponseDataItemCreator

ReposListDeploymentStatusesResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListDeploymentsEndpoint

ReposListDeploymentsEndpoint: { environment?: string; owner: string; page?: number; per_page?: number; ref?: string; repo: string; sha?: string; task?: string }

Type declaration

  • Optional environment?: string

    The name of the environment that was deployed to (e.g., staging or production).

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional ref?: string

    The name of the ref. This can be a branch, tag, or SHA.

  • repo: string

    repo parameter

  • Optional sha?: string

    The SHA recorded at creation time.

  • Optional task?: string

    The name of the task for the deployment (e.g., deploy or deploy:migrations).

ReposListDeploymentsRequestOptions

ReposListDeploymentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments" }

Type declaration

ReposListDeploymentsResponseData

ReposListDeploymentsResponseData: Array<ReposListDeploymentsResponseDataItem>

ReposListDeploymentsResponseDataItem

ReposListDeploymentsResponseDataItem: { created_at: string; creator: ReposListDeploymentsResponseDataItemCreator; description: string; environment: string; id: number; node_id: string; original_environment: string; payload: ReposListDeploymentsResponseDataItemPayload; production_environment: boolean; ref: string; repository_url: string; sha: string; statuses_url: string; task: string; transient_environment: boolean; updated_at: string; url: string }

Type declaration

ReposListDeploymentsResponseDataItemCreator

ReposListDeploymentsResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListDeploymentsResponseDataItemPayload

ReposListDeploymentsResponseDataItemPayload: { deploy: string }

Type declaration

  • deploy: string

ReposListDownloadsEndpoint

ReposListDownloadsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListDownloadsRequestOptions

ReposListDownloadsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/downloads" }

Type declaration

ReposListDownloadsResponseData

ReposListDownloadsResponseData: Array<ReposListDownloadsResponseDataItem>

ReposListDownloadsResponseDataItem

ReposListDownloadsResponseDataItem: { content_type: string; description: string; download_count: number; html_url: string; id: number; name: string; size: number; url: string }

Type declaration

  • content_type: string
  • description: string
  • download_count: number
  • html_url: string
  • id: number
  • name: string
  • size: number
  • url: string

ReposListForAuthenticatedUserEndpoint

ReposListForAuthenticatedUserEndpoint: { affiliation?: string; direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "public" | "private" | "member"; visibility?: "all" | "public" | "private" }

Type declaration

  • Optional affiliation?: string

    Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "public" | "private" | "member"

    Can be one of all, owner, public, private, member. Default: all

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

  • Optional visibility?: "all" | "public" | "private"

    Can be one of all, public, or private.

ReposListForAuthenticatedUserRequestOptions

ReposListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/repos" }

Type declaration

ReposListForOrgEndpoint

ReposListForOrgEndpoint: { direction?: "asc" | "desc"; org: string; page?: number; per_page?: number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

ReposListForOrgRequestOptions

ReposListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/repos" }

Type declaration

ReposListForOrgResponseData

ReposListForOrgResponseData: Array<ReposListForOrgResponseDataItem>

ReposListForOrgResponseDataItem

ReposListForOrgResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ReposListForOrgResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListForOrgResponseDataItemOwner; permissions: ReposListForOrgResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: ReposListForOrgResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposListForOrgResponseDataItemOwner
  • permissions: ReposListForOrgResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposListForOrgResponseDataItemLicense

ReposListForOrgResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ReposListForOrgResponseDataItemOwner

ReposListForOrgResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListForOrgResponseDataItemPermissions

ReposListForOrgResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListForUserEndpoint

ReposListForUserEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "member"; username: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "member"

    Can be one of all, owner, member.

  • username: string

    username parameter

ReposListForUserRequestOptions

ReposListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/repos" }

Type declaration

ReposListForksEndpoint

ReposListForksEndpoint: { owner: string; page?: number; per_page?: number; repo: string; sort?: "newest" | "oldest" | "stargazers" }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sort?: "newest" | "oldest" | "stargazers"

    The sort order. Can be either newest, oldest, or stargazers.

ReposListForksRequestOptions

ReposListForksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/forks" }

Type declaration

ReposListForksResponseData

ReposListForksResponseData: Array<ReposListForksResponseDataItem>

ReposListForksResponseDataItem

ReposListForksResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ReposListForksResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListForksResponseDataItemOwner; permissions: ReposListForksResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: ReposListForksResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposListForksResponseDataItemOwner
  • permissions: ReposListForksResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposListForksResponseDataItemLicense

ReposListForksResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ReposListForksResponseDataItemOwner

ReposListForksResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListForksResponseDataItemPermissions

ReposListForksResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListHooksEndpoint

ReposListHooksEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListHooksRequestOptions

ReposListHooksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks" }

Type declaration

ReposListHooksResponseData

ReposListHooksResponseData: Array<ReposListHooksResponseDataItem>

ReposListHooksResponseDataItem

ReposListHooksResponseDataItem: { active: boolean; config: ReposListHooksResponseDataItemConfig; created_at: string; events: Array<string>; id: number; last_response: ReposListHooksResponseDataItemLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

Type declaration

ReposListHooksResponseDataItemConfig

ReposListHooksResponseDataItemConfig: { content_type: string; insecure_ssl: string; url: string }

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposListHooksResponseDataItemLastResponse

ReposListHooksResponseDataItemLastResponse: { code: null; message: null; status: string }

Type declaration

  • code: null
  • message: null
  • status: string

ReposListInvitationsEndpoint

ReposListInvitationsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListInvitationsForAuthenticatedUserEndpoint

ReposListInvitationsForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ReposListInvitationsForAuthenticatedUserRequestOptions

ReposListInvitationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/repository_invitations" }

Type declaration

ReposListInvitationsForAuthenticatedUserResponseData

ReposListInvitationsForAuthenticatedUserResponseData: Array<ReposListInvitationsForAuthenticatedUserResponseDataItem>

ReposListInvitationsForAuthenticatedUserResponseDataItem

ReposListInvitationsForAuthenticatedUserResponseDataItem: { created_at: string; html_url: string; id: number; invitee: ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee; inviter: ReposListInvitationsForAuthenticatedUserResponseDataItemInviter; permissions: string; repository: ReposListInvitationsForAuthenticatedUserResponseDataItemRepository; url: string }

Type declaration

ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee

ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsForAuthenticatedUserResponseDataItemInviter

ReposListInvitationsForAuthenticatedUserResponseDataItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsForAuthenticatedUserResponseDataItemRepository

ReposListInvitationsForAuthenticatedUserResponseDataItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner

ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsRequestOptions

ReposListInvitationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/invitations" }

Type declaration

ReposListInvitationsResponseData

ReposListInvitationsResponseData: Array<ReposListInvitationsResponseDataItem>

ReposListInvitationsResponseDataItem

ReposListInvitationsResponseDataItem: { created_at: string; html_url: string; id: number; invitee: ReposListInvitationsResponseDataItemInvitee; inviter: ReposListInvitationsResponseDataItemInviter; permissions: string; repository: ReposListInvitationsResponseDataItemRepository; url: string }

Type declaration

ReposListInvitationsResponseDataItemInvitee

ReposListInvitationsResponseDataItemInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsResponseDataItemInviter

ReposListInvitationsResponseDataItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsResponseDataItemRepository

ReposListInvitationsResponseDataItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposListInvitationsResponseDataItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ReposListInvitationsResponseDataItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposListInvitationsResponseDataItemRepositoryOwner

ReposListInvitationsResponseDataItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListLanguagesEndpoint

ReposListLanguagesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListLanguagesRequestOptions

ReposListLanguagesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/languages" }

Type declaration

ReposListLanguagesResponseData

ReposListLanguagesResponseData: { C: number; Python: number }

Type declaration

  • C: number
  • Python: number

ReposListPagesBuildsEndpoint

ReposListPagesBuildsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListPagesBuildsRequestOptions

ReposListPagesBuildsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds" }

Type declaration

ReposListPagesBuildsResponseData

ReposListPagesBuildsResponseData: Array<ReposListPagesBuildsResponseDataItem>

ReposListPagesBuildsResponseDataItem

ReposListPagesBuildsResponseDataItem: { commit: string; created_at: string; duration: number; error: ReposListPagesBuildsResponseDataItemError; pusher: ReposListPagesBuildsResponseDataItemPusher; status: string; updated_at: string; url: string }

Type declaration

ReposListPagesBuildsResponseDataItemError

ReposListPagesBuildsResponseDataItemError: { message: null }

Type declaration

  • message: null

ReposListPagesBuildsResponseDataItemPusher

ReposListPagesBuildsResponseDataItemPusher: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListProtectedBranchRequiredStatusChecksContextsEndpoint

ReposListProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposListProtectedBranchRequiredStatusChecksContextsResponseData

ReposListProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposListPublicEndpoint

ReposListPublicEndpoint: { page?: number; per_page?: number; since?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: number

    The integer ID of the last repository that you've seen.

ReposListPublicRequestOptions

ReposListPublicRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repositories" }

Type declaration

ReposListPublicResponseData

ReposListPublicResponseData: Array<ReposListPublicResponseDataItem>

ReposListPublicResponseDataItem

ReposListPublicResponseDataItem: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposListPublicResponseDataItemOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ReposListPublicResponseDataItemOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposListPublicResponseDataItemOwner

ReposListPublicResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitEndpoint

ReposListPullRequestsAssociatedWithCommitEndpoint: { commit_sha: string; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListPullRequestsAssociatedWithCommitRequestOptions

ReposListPullRequestsAssociatedWithCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/pulls" }

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseData

ReposListPullRequestsAssociatedWithCommitResponseData: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItem>

ReposListPullRequestsAssociatedWithCommitResponseDataItem

ReposListPullRequestsAssociatedWithCommitResponseDataItem: { _links: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks; active_lock_reason: string; assignee: ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee; assignees: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem>; author_association: string; base: ReposListPullRequestsAssociatedWithCommitResponseDataItemBase; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: ReposListPullRequestsAssociatedWithCommitResponseDataItemHead; html_url: string; id: number; issue_url: string; labels: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem>; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone; node_id: string; number: number; patch_url: string; requested_reviewers: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem>; requested_teams: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem>; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: ReposListPullRequestsAssociatedWithCommitResponseDataItemUser }

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemBase

ReposListPullRequestsAssociatedWithCommitResponseDataItemBase: { label: string; ref: string; repo: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo; sha: string; user: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser }

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner; permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner
  • permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemHead

ReposListPullRequestsAssociatedWithCommitResponseDataItemHead: { label: string; ref: string; repo: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo; sha: string; user: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser }

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner; permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner
  • permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks: { comments: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksComments; commits: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksCommits; html: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksHtml; issue: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksIssue; review_comment: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComment; review_comments: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComments; self: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksSelf; statuses: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksStatuses }

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksComments

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksComments: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksCommits

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksCommits: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksHtml

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksHtml: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksIssue

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksIssue: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComment

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComment: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComments

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComments: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksSelf

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksSelf: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksStatuses

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksStatuses: { href: string }

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListReleasesEndpoint

ReposListReleasesEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListReleasesRequestOptions

ReposListReleasesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases" }

Type declaration

ReposListReleasesResponseData

ReposListReleasesResponseData: Array<ReposListReleasesResponseDataItem>

ReposListReleasesResponseDataItem

ReposListReleasesResponseDataItem: { assets: Array<ReposListReleasesResponseDataItemAssetsItem>; assets_url: string; author: ReposListReleasesResponseDataItemAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

Type declaration

ReposListReleasesResponseDataItemAssetsItem

ReposListReleasesResponseDataItemAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposListReleasesResponseDataItemAssetsItemUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposListReleasesResponseDataItemAssetsItemUploader
  • url: string

ReposListReleasesResponseDataItemAssetsItemUploader

ReposListReleasesResponseDataItemAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListReleasesResponseDataItemAuthor

ReposListReleasesResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListStatusesForRefEndpoint

ReposListStatusesForRefEndpoint: { owner: string; page?: number; per_page?: number; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposListStatusesForRefRequestOptions

ReposListStatusesForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/statuses" }

Type declaration

ReposListStatusesForRefResponseData

ReposListStatusesForRefResponseData: Array<ReposListStatusesForRefResponseDataItem>

ReposListStatusesForRefResponseDataItem

ReposListStatusesForRefResponseDataItem: { avatar_url: string; context: string; created_at: string; creator: ReposListStatusesForRefResponseDataItemCreator; description: string; id: number; node_id: string; state: string; target_url: string; updated_at: string; url: string }

Type declaration

ReposListStatusesForRefResponseDataItemCreator

ReposListStatusesForRefResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListTagsEndpoint

ReposListTagsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListTagsRequestOptions

ReposListTagsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/tags" }

Type declaration

ReposListTagsResponseData

ReposListTagsResponseData: Array<ReposListTagsResponseDataItem>

ReposListTagsResponseDataItem

ReposListTagsResponseDataItem: { commit: ReposListTagsResponseDataItemCommit; name: string; tarball_url: string; zipball_url: string }

Type declaration

ReposListTagsResponseDataItemCommit

ReposListTagsResponseDataItemCommit: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposListTeamsEndpoint

ReposListTeamsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListTeamsRequestOptions

ReposListTeamsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/teams" }

Type declaration

ReposListTeamsResponseData

ReposListTeamsResponseData: Array<ReposListTeamsResponseDataItem>

ReposListTeamsResponseDataItem

ReposListTeamsResponseDataItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposMergeEndpoint

ReposMergeEndpoint: { base: string; commit_message?: string; head: string; owner: string; repo: string }

Type declaration

  • base: string

    The name of the base branch that the head will be merged into.

  • Optional commit_message?: string

    Commit message to use for the merge commit. If omitted, a default message will be used.

  • head: string

    The head to merge. This can be a branch name or a commit SHA1.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposMergeRequestOptions

ReposMergeRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/merges" }

Type declaration

ReposMergeResponseData

ReposMergeResponseData: { author: ReposMergeResponseDataAuthor; comments_url: string; commit: ReposMergeResponseDataCommit; committer: ReposMergeResponseDataCommitter; html_url: string; node_id: string; parents: Array<ReposMergeResponseDataParentsItem>; sha: string; url: string }

Type declaration

ReposMergeResponseDataAuthor

ReposMergeResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposMergeResponseDataCommit

ReposMergeResponseDataCommit: { author: ReposMergeResponseDataCommitAuthor; comment_count: number; committer: ReposMergeResponseDataCommitCommitter; message: string; tree: ReposMergeResponseDataCommitTree; url: string; verification: ReposMergeResponseDataCommitVerification }

Type declaration

ReposMergeResponseDataCommitAuthor

ReposMergeResponseDataCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposMergeResponseDataCommitCommitter

ReposMergeResponseDataCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

ReposMergeResponseDataCommitTree

ReposMergeResponseDataCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposMergeResponseDataCommitVerification

ReposMergeResponseDataCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposMergeResponseDataCommitter

ReposMergeResponseDataCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposMergeResponseDataParentsItem

ReposMergeResponseDataParentsItem: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

ReposPingHookEndpoint

ReposPingHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposPingHookRequestOptions

ReposPingHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id/pings" }

Type declaration

ReposRemoveBranchProtectionEndpoint

ReposRemoveBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveBranchProtectionRequestOptions

ReposRemoveBranchProtectionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection" }

Type declaration

ReposRemoveCollaboratorEndpoint

ReposRemoveCollaboratorEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposRemoveCollaboratorRequestOptions

ReposRemoveCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username" }

Type declaration

ReposRemoveDeployKeyEndpoint

ReposRemoveDeployKeyEndpoint: { key_id: number; owner: string; repo: string }

Type declaration

  • key_id: number

    key_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveDeployKeyRequestOptions

ReposRemoveDeployKeyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys/:key_id" }

Type declaration

ReposRemoveProtectedBranchAdminEnforcementEndpoint

ReposRemoveProtectedBranchAdminEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchAdminEnforcementRequestOptions

ReposRemoveProtectedBranchAdminEnforcementRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" }

Type declaration

ReposRemoveProtectedBranchAppRestrictionsEndpoint

ReposRemoveProtectedBranchAppRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchAppRestrictionsRequestOptions

ReposRemoveProtectedBranchAppRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposRemoveProtectedBranchAppRestrictionsResponseData

ReposRemoveProtectedBranchAppRestrictionsResponseData: Array<ReposRemoveProtectedBranchAppRestrictionsResponseDataItem>

ReposRemoveProtectedBranchAppRestrictionsResponseDataItem

ReposRemoveProtectedBranchAppRestrictionsResponseDataItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner; permissions: ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions; slug: string; updated_at: string }

Type declaration

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint

ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" }

Type declaration

ReposRemoveProtectedBranchRequiredSignaturesEndpoint

ReposRemoveProtectedBranchRequiredSignaturesEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRequiredSignaturesRequestOptions

ReposRemoveProtectedBranchRequiredSignaturesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" }

Type declaration

ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint

ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • contexts: string[]

    contexts parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData

ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposRemoveProtectedBranchRequiredStatusChecksEndpoint

ReposRemoveProtectedBranchRequiredStatusChecksEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions

ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" }

Type declaration

ReposRemoveProtectedBranchRestrictionsEndpoint

ReposRemoveProtectedBranchRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRestrictionsRequestOptions

ReposRemoveProtectedBranchRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions" }

Type declaration

ReposRemoveProtectedBranchTeamRestrictionsEndpoint

ReposRemoveProtectedBranchTeamRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • teams: string[]

    teams parameter

ReposRemoveProtectedBranchTeamRestrictionsRequestOptions

ReposRemoveProtectedBranchTeamRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposRemoveProtectedBranchTeamRestrictionsResponseData

ReposRemoveProtectedBranchTeamRestrictionsResponseData: Array<ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem>

ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem

ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposRemoveProtectedBranchUserRestrictionsEndpoint

ReposRemoveProtectedBranchUserRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • users: string[]

    users parameter

ReposRemoveProtectedBranchUserRestrictionsRequestOptions

ReposRemoveProtectedBranchUserRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposRemoveProtectedBranchUserRestrictionsResponseData

ReposRemoveProtectedBranchUserRestrictionsResponseData: Array<ReposRemoveProtectedBranchUserRestrictionsResponseDataItem>

ReposRemoveProtectedBranchUserRestrictionsResponseDataItem

ReposRemoveProtectedBranchUserRestrictionsResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposReplaceAllTopicsEndpoint

ReposReplaceAllTopicsEndpoint: { names: string[]; owner: string; repo: string }

Type declaration

  • names: string[]

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposReplaceAllTopicsRequestOptions

ReposReplaceAllTopicsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/topics" }

Type declaration

ReposReplaceAllTopicsResponseData

ReposReplaceAllTopicsResponseData: { names: Array<string> }

Type declaration

  • names: Array<string>

ReposReplaceProtectedBranchAppRestrictionsEndpoint

ReposReplaceProtectedBranchAppRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposReplaceProtectedBranchAppRestrictionsRequestOptions

ReposReplaceProtectedBranchAppRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposReplaceProtectedBranchAppRestrictionsResponseData

ReposReplaceProtectedBranchAppRestrictionsResponseData: Array<ReposReplaceProtectedBranchAppRestrictionsResponseDataItem>

ReposReplaceProtectedBranchAppRestrictionsResponseDataItem

ReposReplaceProtectedBranchAppRestrictionsResponseDataItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner; permissions: ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions; slug: string; updated_at: string }

Type declaration

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint

ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • contexts: string[]

    contexts parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData

ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposReplaceProtectedBranchTeamRestrictionsEndpoint

ReposReplaceProtectedBranchTeamRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • teams: string[]

    teams parameter

ReposReplaceProtectedBranchTeamRestrictionsRequestOptions

ReposReplaceProtectedBranchTeamRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposReplaceProtectedBranchTeamRestrictionsResponseData

ReposReplaceProtectedBranchTeamRestrictionsResponseData: Array<ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem>

ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem

ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposReplaceProtectedBranchUserRestrictionsEndpoint

ReposReplaceProtectedBranchUserRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • users: string[]

    users parameter

ReposReplaceProtectedBranchUserRestrictionsRequestOptions

ReposReplaceProtectedBranchUserRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposReplaceProtectedBranchUserRestrictionsResponseData

ReposReplaceProtectedBranchUserRestrictionsResponseData: Array<ReposReplaceProtectedBranchUserRestrictionsResponseDataItem>

ReposReplaceProtectedBranchUserRestrictionsResponseDataItem

ReposReplaceProtectedBranchUserRestrictionsResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposRequestPageBuildEndpoint

ReposRequestPageBuildEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRequestPageBuildRequestOptions

ReposRequestPageBuildRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds" }

Type declaration

ReposRequestPageBuildResponseData

ReposRequestPageBuildResponseData: { status: string; url: string }

Type declaration

  • status: string
  • url: string

ReposRetrieveCommunityProfileMetricsEndpoint

ReposRetrieveCommunityProfileMetricsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRetrieveCommunityProfileMetricsRequestOptions

ReposRetrieveCommunityProfileMetricsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/community/profile" }

Type declaration

ReposRetrieveCommunityProfileMetricsResponseData

ReposRetrieveCommunityProfileMetricsResponseData: { description: string; documentation: boolean; files: ReposRetrieveCommunityProfileMetricsResponseDataFiles; health_percentage: number; updated_at: string }

Type declaration

ReposRetrieveCommunityProfileMetricsResponseDataFiles

ReposRetrieveCommunityProfileMetricsResponseDataFiles: { code_of_conduct: ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct; contributing: ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing; issue_template: ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate; license: ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense; pull_request_template: ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate; readme: ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme }

Type declaration

ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct

ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct: { html_url: string; key: string; name: string; url: string }

Type declaration

  • html_url: string
  • key: string
  • name: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing

ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing: { html_url: string; url: string }

Type declaration

  • html_url: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate

ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate: { html_url: string; url: string }

Type declaration

  • html_url: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense

ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense: { html_url: string; key: string; name: string; spdx_id: string; url: string }

Type declaration

  • html_url: string
  • key: string
  • name: string
  • spdx_id: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate

ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate: { html_url: string; url: string }

Type declaration

  • html_url: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme

ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme: { html_url: string; url: string }

Type declaration

  • html_url: string
  • url: string

ReposTestPushHookEndpoint

ReposTestPushHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposTestPushHookRequestOptions

ReposTestPushHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id/tests" }

Type declaration

ReposTransferEndpoint

ReposTransferEndpoint: { new_owner?: string; owner: string; repo: string; team_ids?: number[] }

Type declaration

  • Optional new_owner?: string

    Required: The username or organization name the repository will be transferred to.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional team_ids?: number[]

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

ReposTransferRequestOptions

ReposTransferRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/transfer" }

Type declaration

ReposTransferResponseData

ReposTransferResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposTransferResponseDataOwner; permissions: ReposTransferResponseDataPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposTransferResponseDataOwner
  • permissions: ReposTransferResponseDataPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposTransferResponseDataOwner

ReposTransferResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposTransferResponseDataPermissions

ReposTransferResponseDataPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposUpdateBranchProtectionEndpoint

ReposUpdateBranchProtectionEndpoint: { allow_deletions?: boolean; allow_force_pushes?: boolean | null; branch: string; enforce_admins: boolean | null; owner: string; repo: string; required_linear_history?: boolean; required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; restrictions: ReposUpdateBranchProtectionParamsRestrictions | null }

Type declaration

  • Optional allow_deletions?: boolean

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.

  • Optional allow_force_pushes?: boolean | null

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."

  • branch: string

    branch parameter

  • enforce_admins: boolean | null

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional required_linear_history?: boolean

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.

  • required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null

    Require at least one approving review on a pull request, before merging. Set to null to disable.

  • required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null

    Require status checks to pass before merging. Set to null to disable.

  • restrictions: ReposUpdateBranchProtectionParamsRestrictions | null

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews: { dismiss_stale_reviews?: boolean; dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews?: boolean; required_approving_review_count?: number }

Type declaration

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions: { teams?: string[]; users?: string[] }

Type declaration

  • Optional teams?: string[]
  • Optional users?: string[]

ReposUpdateBranchProtectionParamsRequiredStatusChecks

ReposUpdateBranchProtectionParamsRequiredStatusChecks: { contexts: string[]; strict: boolean }

Type declaration

  • contexts: string[]
  • strict: boolean

ReposUpdateBranchProtectionParamsRestrictions

ReposUpdateBranchProtectionParamsRestrictions: { apps?: string[]; teams: string[]; users: string[] }

Type declaration

  • Optional apps?: string[]
  • teams: string[]
  • users: string[]

ReposUpdateBranchProtectionRequestOptions

ReposUpdateBranchProtectionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection" }

Type declaration

ReposUpdateBranchProtectionResponseData

ReposUpdateBranchProtectionResponseData: { allow_deletions: ReposUpdateBranchProtectionResponseDataAllowDeletions; allow_force_pushes: ReposUpdateBranchProtectionResponseDataAllowForcePushes; enforce_admins: ReposUpdateBranchProtectionResponseDataEnforceAdmins; required_linear_history: ReposUpdateBranchProtectionResponseDataRequiredLinearHistory; required_pull_request_reviews: ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews; required_status_checks: ReposUpdateBranchProtectionResponseDataRequiredStatusChecks; restrictions: ReposUpdateBranchProtectionResponseDataRestrictions; url: string }

Type declaration

ReposUpdateBranchProtectionResponseDataAllowDeletions

ReposUpdateBranchProtectionResponseDataAllowDeletions: { enabled: boolean }

Type declaration

  • enabled: boolean

ReposUpdateBranchProtectionResponseDataAllowForcePushes

ReposUpdateBranchProtectionResponseDataAllowForcePushes: { enabled: boolean }

Type declaration

  • enabled: boolean

ReposUpdateBranchProtectionResponseDataEnforceAdmins

ReposUpdateBranchProtectionResponseDataEnforceAdmins: { enabled: boolean; url: string }

Type declaration

  • enabled: boolean
  • url: string

ReposUpdateBranchProtectionResponseDataRequiredLinearHistory

ReposUpdateBranchProtectionResponseDataRequiredLinearHistory: { enabled: boolean }

Type declaration

  • enabled: boolean

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

Type declaration

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions: { teams: Array<ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem>; users_url: string }

Type declaration

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateBranchProtectionResponseDataRequiredStatusChecks

ReposUpdateBranchProtectionResponseDataRequiredStatusChecks: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposUpdateBranchProtectionResponseDataRestrictions

ReposUpdateBranchProtectionResponseDataRestrictions: { apps: Array<ReposUpdateBranchProtectionResponseDataRestrictionsAppsItem>; apps_url: string; teams: Array<ReposUpdateBranchProtectionResponseDataRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposUpdateBranchProtectionResponseDataRestrictionsUsersItem>; users_url: string }

Type declaration

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItem

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner; permissions: ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions; slug: string; updated_at: string }

Type declaration

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

Type declaration

  • avatar_url: string
  • description: string
  • events_url: string
  • hooks_url: string
  • id: number
  • issues_url: string
  • login: string
  • members_url: string
  • node_id: string
  • public_members_url: string
  • repos_url: string
  • url: string

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposUpdateBranchProtectionResponseDataRestrictionsTeamsItem

ReposUpdateBranchProtectionResponseDataRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposUpdateBranchProtectionResponseDataRestrictionsUsersItem

ReposUpdateBranchProtectionResponseDataRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateCommitCommentEndpoint

ReposUpdateCommitCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposUpdateCommitCommentRequestOptions

ReposUpdateCommitCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id" }

Type declaration

ReposUpdateCommitCommentResponseData

ReposUpdateCommitCommentResponseData: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposUpdateCommitCommentResponseDataUser }

Type declaration

  • body: string
  • commit_id: string
  • created_at: string
  • html_url: string
  • id: number
  • line: number
  • node_id: string
  • path: string
  • position: number
  • updated_at: string
  • url: string
  • user: ReposUpdateCommitCommentResponseDataUser

ReposUpdateCommitCommentResponseDataUser

ReposUpdateCommitCommentResponseDataUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateEndpoint

ReposUpdateEndpoint: { allow_merge_commit?: boolean; allow_rebase_merge?: boolean; allow_squash_merge?: boolean; archived?: boolean; default_branch?: string; delete_branch_on_merge?: boolean; description?: string; has_issues?: boolean; has_projects?: boolean; has_wiki?: boolean; homepage?: string; is_template?: boolean; name?: string; owner: string; private?: boolean; repo: string; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: boolean

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: boolean

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: boolean

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional archived?: boolean

    true to archive this repository. Note: You cannot unarchive repositories through the API.

  • Optional default_branch?: string

    Updates the default branch for this repository.

  • Optional delete_branch_on_merge?: boolean

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: string

    A short description of the repository.

  • Optional has_issues?: boolean

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: boolean

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: boolean

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: string

    A URL with more information about the repository.

  • Optional is_template?: boolean

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional name?: string

    The name of the repository.

  • owner: string

    owner parameter

  • Optional private?: boolean

    Either true to make the repository private or false to make it public. Creating private repositories requires a paid GitHub account. Default: false. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

  • repo: string

    repo parameter

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

ReposUpdateHookEndpoint

ReposUpdateHookEndpoint: { active?: boolean; add_events?: string[]; config?: ReposUpdateHookParamsConfig; events?: string[]; hook_id: number; owner: string; remove_events?: string[]; repo: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional add_events?: string[]

    Determines a list of events to be added to the list of events that the Hook triggers for.

  • Optional config?: ReposUpdateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for. This replaces the entire array of events.

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • Optional remove_events?: string[]

    Determines a list of events to be removed from the list of events that the Hook triggers for.

  • repo: string

    repo parameter

ReposUpdateHookParamsConfig

ReposUpdateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

ReposUpdateHookRequestOptions

ReposUpdateHookRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id" }

Type declaration

ReposUpdateHookResponseData

ReposUpdateHookResponseData: { active: boolean; config: ReposUpdateHookResponseDataConfig; created_at: string; events: Array<string>; id: number; last_response: ReposUpdateHookResponseDataLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

Type declaration

ReposUpdateHookResponseDataConfig

ReposUpdateHookResponseDataConfig: { content_type: string; insecure_ssl: string; url: string }

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposUpdateHookResponseDataLastResponse

ReposUpdateHookResponseDataLastResponse: { code: null; message: null; status: string }

Type declaration

  • code: null
  • message: null
  • status: string

ReposUpdateInformationAboutPagesSiteEndpoint

ReposUpdateInformationAboutPagesSiteEndpoint: { cname?: string; owner: string; repo: string; source?: ""gh-pages"" | ""master"" | ""master /docs"" }

Type declaration

  • Optional cname?: string

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional source?: ""gh-pages"" | ""master"" | ""master /docs""

    Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".

ReposUpdateInformationAboutPagesSiteRequestOptions

ReposUpdateInformationAboutPagesSiteRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposUpdateInvitationEndpoint

ReposUpdateInvitationEndpoint: { invitation_id: number; owner: string; permissions?: "read" | "write" | "maintain" | "triage" | "admin"; repo: string }

Type declaration

  • invitation_id: number

    invitation_id parameter

  • owner: string

    owner parameter

  • Optional permissions?: "read" | "write" | "maintain" | "triage" | "admin"

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

  • repo: string

    repo parameter

ReposUpdateInvitationRequestOptions

ReposUpdateInvitationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/invitations/:invitation_id" }

Type declaration

ReposUpdateInvitationResponseData

ReposUpdateInvitationResponseData: { created_at: string; html_url: string; id: number; invitee: ReposUpdateInvitationResponseDataInvitee; inviter: ReposUpdateInvitationResponseDataInviter; permissions: string; repository: ReposUpdateInvitationResponseDataRepository; url: string }

Type declaration

ReposUpdateInvitationResponseDataInvitee

ReposUpdateInvitationResponseDataInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateInvitationResponseDataInviter

ReposUpdateInvitationResponseDataInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateInvitationResponseDataRepository

ReposUpdateInvitationResponseDataRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposUpdateInvitationResponseDataRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ReposUpdateInvitationResponseDataRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposUpdateInvitationResponseDataRepositoryOwner

ReposUpdateInvitationResponseDataRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint

ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint: { branch: string; dismiss_stale_reviews?: boolean; dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; owner: string; repo: string; require_code_owner_reviews?: boolean; required_approving_review_count?: number }

Type declaration

  • branch: string

    branch parameter

  • Optional dismiss_stale_reviews?: boolean

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

  • Optional dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

    Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional require_code_owner_reviews?: boolean

    Blocks merging pull requests until code owners have reviewed.

  • Optional required_approving_review_count?: number

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions: { teams?: string[]; users?: string[] }

Type declaration

  • Optional teams?: string[]
  • Optional users?: string[]

ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" }

Type declaration

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

Type declaration

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions: { teams: Array<ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem>; users_url: string }

Type declaration

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateProtectedBranchRequiredStatusChecksEndpoint

ReposUpdateProtectedBranchRequiredStatusChecksEndpoint: { branch: string; contexts?: string[]; owner: string; repo: string; strict?: boolean }

Type declaration

  • branch: string

    branch parameter

  • Optional contexts?: string[]

    The list of status checks to require in order to merge into this branch

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional strict?: boolean

    Require branches to be up to date before merging.

ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions

ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" }

Type declaration

ReposUpdateProtectedBranchRequiredStatusChecksResponseData

ReposUpdateProtectedBranchRequiredStatusChecksResponseData: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposUpdateReleaseAssetEndpoint

ReposUpdateReleaseAssetEndpoint: { asset_id: number; label?: string; name?: string; owner: string; repo: string }

Type declaration

  • asset_id: number

    asset_id parameter

  • Optional label?: string

    An alternate short description of the asset. Used in place of the filename.

  • Optional name?: string

    The file name of the asset.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposUpdateReleaseAssetRequestOptions

ReposUpdateReleaseAssetRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/assets/:asset_id" }

Type declaration

ReposUpdateReleaseAssetResponseData

ReposUpdateReleaseAssetResponseData: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposUpdateReleaseAssetResponseDataUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposUpdateReleaseAssetResponseDataUploader
  • url: string

ReposUpdateReleaseAssetResponseDataUploader

ReposUpdateReleaseAssetResponseDataUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateReleaseEndpoint

ReposUpdateReleaseEndpoint: { body?: string; draft?: boolean; name?: string; owner: string; prerelease?: boolean; release_id: number; repo: string; tag_name?: string; target_commitish?: string }

Type declaration

  • Optional body?: string

    Text describing the contents of the tag.

  • Optional draft?: boolean

    true makes the release a draft, and false publishes the release.

  • Optional name?: string

    The name of the release.

  • owner: string

    owner parameter

  • Optional prerelease?: boolean

    true to identify the release as a prerelease, false to identify the release as a full release.

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

  • Optional tag_name?: string

    The name of the tag.

  • Optional target_commitish?: string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposUpdateReleaseRequestOptions

ReposUpdateReleaseRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id" }

Type declaration

ReposUpdateReleaseResponseData

ReposUpdateReleaseResponseData: { assets: Array<ReposUpdateReleaseResponseDataAssetsItem>; assets_url: string; author: ReposUpdateReleaseResponseDataAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

Type declaration

ReposUpdateReleaseResponseDataAssetsItem

ReposUpdateReleaseResponseDataAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposUpdateReleaseResponseDataAssetsItemUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposUpdateReleaseResponseDataAssetsItemUploader
  • url: string

ReposUpdateReleaseResponseDataAssetsItemUploader

ReposUpdateReleaseResponseDataAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateReleaseResponseDataAuthor

ReposUpdateReleaseResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateRequestOptions

ReposUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo" }

Type declaration

ReposUpdateResponseData

ReposUpdateResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; organization: ReposUpdateResponseDataOrganization; owner: ReposUpdateResponseDataOwner; parent: ReposUpdateResponseDataParent; permissions: ReposUpdateResponseDataPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; source: ReposUpdateResponseDataSource; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • organization: ReposUpdateResponseDataOrganization
  • owner: ReposUpdateResponseDataOwner
  • parent: ReposUpdateResponseDataParent
  • permissions: ReposUpdateResponseDataPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • source: ReposUpdateResponseDataSource
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposUpdateResponseDataOrganization

ReposUpdateResponseDataOrganization: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseDataOwner

ReposUpdateResponseDataOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseDataParent

ReposUpdateResponseDataParent: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposUpdateResponseDataParentOwner; permissions: ReposUpdateResponseDataParentPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposUpdateResponseDataParentOwner
  • permissions: ReposUpdateResponseDataParentPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposUpdateResponseDataParentOwner

ReposUpdateResponseDataParentOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseDataParentPermissions

ReposUpdateResponseDataParentPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposUpdateResponseDataPermissions

ReposUpdateResponseDataPermissions: { admin: boolean; maintain: boolean; pull: boolean; push: boolean; triage: boolean }

Type declaration

  • admin: boolean
  • maintain: boolean
  • pull: boolean
  • push: boolean
  • triage: boolean

ReposUpdateResponseDataSource

ReposUpdateResponseDataSource: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposUpdateResponseDataSourceOwner; permissions: ReposUpdateResponseDataSourcePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposUpdateResponseDataSourceOwner
  • permissions: ReposUpdateResponseDataSourcePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ReposUpdateResponseDataSourceOwner

ReposUpdateResponseDataSourceOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseDataSourcePermissions

ReposUpdateResponseDataSourcePermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposUploadReleaseAssetEndpoint

ReposUploadReleaseAssetEndpoint: { data: string; label?: string; name?: string; origin?: string; owner: string; release_id: number; repo: string }

Type declaration

  • data: string

    The raw file data

  • Optional label?: string

    label parameter

  • Optional name?: string

    name parameter

  • Optional origin?: string

    The URL origin (protocol + host name + port) is included in upload_url returned in the response of the "Create a release" endpoint

  • owner: string

    owner parameter

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposUploadReleaseAssetRequestOptions

ReposUploadReleaseAssetRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: ":origin/repos/:owner/:repo/releases/:release_id/assets:?name,label" }

Type declaration

ReposUploadReleaseAssetResponseData

ReposUploadReleaseAssetResponseData: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposUploadReleaseAssetResponseDataUploader; url: string }

Type declaration

  • browser_download_url: string
  • content_type: string
  • created_at: string
  • download_count: number
  • id: number
  • label: string
  • name: string
  • node_id: string
  • size: number
  • state: string
  • updated_at: string
  • uploader: ReposUploadReleaseAssetResponseDataUploader
  • url: string

ReposUploadReleaseAssetResponseDataUploader

ReposUploadReleaseAssetResponseDataUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ScimGetProvisioningDetailsForUserEndpoint

ScimGetProvisioningDetailsForUserEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimGetProvisioningDetailsForUserRequestOptions

ScimGetProvisioningDetailsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

ScimGetProvisioningDetailsForUserResponseData

ScimGetProvisioningDetailsForUserResponseData: { active: boolean; emails: Array<ScimGetProvisioningDetailsForUserResponseDataEmailsItem>; externalId: string; id: string; meta: ScimGetProvisioningDetailsForUserResponseDataMeta; name: ScimGetProvisioningDetailsForUserResponseDataName; schemas: Array<string>; userName: string }

Type declaration

ScimGetProvisioningDetailsForUserResponseDataEmailsItem

ScimGetProvisioningDetailsForUserResponseDataEmailsItem: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

ScimGetProvisioningDetailsForUserResponseDataMeta

ScimGetProvisioningDetailsForUserResponseDataMeta: { created: string; lastModified: string; location: string; resourceType: string }

Type declaration

  • created: string
  • lastModified: string
  • location: string
  • resourceType: string

ScimGetProvisioningDetailsForUserResponseDataName

ScimGetProvisioningDetailsForUserResponseDataName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

ScimListProvisionedIdentitiesEndpoint

ScimListProvisionedIdentitiesEndpoint: { count?: number; filter?: string; org: string; startIndex?: number }

Type declaration

  • Optional count?: number

    Used for pagination: the number of results to return.

  • Optional filter?: string

    Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query: ?filter=userName%20eq%20\"Octocat\".

  • org: string

    org parameter

  • Optional startIndex?: number

    Used for pagination: the index of the first result to return.

ScimListProvisionedIdentitiesRequestOptions

ScimListProvisionedIdentitiesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users" }

Type declaration

ScimListProvisionedIdentitiesResponseData

ScimListProvisionedIdentitiesResponseData: { Resources: Array<ScimListProvisionedIdentitiesResponseDataResourcesItem>; itemsPerPage: number; schemas: Array<string>; startIndex: number; totalResults: number }

Type declaration

ScimListProvisionedIdentitiesResponseDataResourcesItem

ScimListProvisionedIdentitiesResponseDataResourcesItem: { active: boolean; emails: Array<ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem>; externalId: string; id: string; meta: ScimListProvisionedIdentitiesResponseDataResourcesItemMeta; name: ScimListProvisionedIdentitiesResponseDataResourcesItemName; schemas: Array<string>; userName: string }

Type declaration

ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem

ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

ScimListProvisionedIdentitiesResponseDataResourcesItemMeta

ScimListProvisionedIdentitiesResponseDataResourcesItemMeta: { created: string; lastModified: string; location: string; resourceType: string }

Type declaration

  • created: string
  • lastModified: string
  • location: string
  • resourceType: string

ScimListProvisionedIdentitiesResponseDataResourcesItemName

ScimListProvisionedIdentitiesResponseDataResourcesItemName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

ScimProvisionAndInviteUsersEndpoint

ScimProvisionAndInviteUsersEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

ScimProvisionAndInviteUsersRequestOptions

ScimProvisionAndInviteUsersRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users" }

Type declaration

ScimProvisionAndInviteUsersResponseData

ScimProvisionAndInviteUsersResponseData: { active: boolean; emails: Array<ScimProvisionAndInviteUsersResponseDataEmailsItem>; externalId: string; id: string; meta: ScimProvisionAndInviteUsersResponseDataMeta; name: ScimProvisionAndInviteUsersResponseDataName; schemas: Array<string>; userName: string }

Type declaration

ScimProvisionAndInviteUsersResponseDataEmailsItem

ScimProvisionAndInviteUsersResponseDataEmailsItem: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

ScimProvisionAndInviteUsersResponseDataMeta

ScimProvisionAndInviteUsersResponseDataMeta: { created: string; lastModified: string; location: string; resourceType: string }

Type declaration

  • created: string
  • lastModified: string
  • location: string
  • resourceType: string

ScimProvisionAndInviteUsersResponseDataName

ScimProvisionAndInviteUsersResponseDataName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

ScimRemoveUserFromOrgEndpoint

ScimRemoveUserFromOrgEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimRemoveUserFromOrgRequestOptions

ScimRemoveUserFromOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

ScimReplaceProvisionedUserInformationEndpoint

ScimReplaceProvisionedUserInformationEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimReplaceProvisionedUserInformationRequestOptions

ScimReplaceProvisionedUserInformationRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

ScimReplaceProvisionedUserInformationResponseData

ScimReplaceProvisionedUserInformationResponseData: { active: boolean; emails: Array<ScimReplaceProvisionedUserInformationResponseDataEmailsItem>; externalId: string; id: string; meta: ScimReplaceProvisionedUserInformationResponseDataMeta; name: ScimReplaceProvisionedUserInformationResponseDataName; schemas: Array<string>; userName: string }

Type declaration

ScimReplaceProvisionedUserInformationResponseDataEmailsItem

ScimReplaceProvisionedUserInformationResponseDataEmailsItem: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

ScimReplaceProvisionedUserInformationResponseDataMeta

ScimReplaceProvisionedUserInformationResponseDataMeta: { created: string; lastModified: string; location: string; resourceType: string }

Type declaration

  • created: string
  • lastModified: string
  • location: string
  • resourceType: string

ScimReplaceProvisionedUserInformationResponseDataName

ScimReplaceProvisionedUserInformationResponseDataName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

ScimUpdateUserAttributeEndpoint

ScimUpdateUserAttributeEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimUpdateUserAttributeRequestOptions

ScimUpdateUserAttributeRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

ScimUpdateUserAttributeResponseData

ScimUpdateUserAttributeResponseData: { active: boolean; emails: Array<ScimUpdateUserAttributeResponseDataEmailsItem>; externalId: string; id: string; meta: ScimUpdateUserAttributeResponseDataMeta; name: ScimUpdateUserAttributeResponseDataName; schemas: Array<string>; userName: string }

Type declaration

ScimUpdateUserAttributeResponseDataEmailsItem

ScimUpdateUserAttributeResponseDataEmailsItem: { primary?: boolean; type: string; value: string }

Type declaration

  • Optional primary?: boolean
  • type: string
  • value: string

ScimUpdateUserAttributeResponseDataMeta

ScimUpdateUserAttributeResponseDataMeta: { created: string; lastModified: string; location: string; resourceType: string }

Type declaration

  • created: string
  • lastModified: string
  • location: string
  • resourceType: string

ScimUpdateUserAttributeResponseDataName

ScimUpdateUserAttributeResponseDataName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

SearchCodeEndpoint

SearchCodeEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "indexed" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

  • Optional sort?: "indexed"

    Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

SearchCodeRequestOptions

SearchCodeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/code" }

Type declaration

SearchCodeResponseData

SearchCodeResponseData: { incomplete_results: boolean; items: Array<SearchCodeResponseDataItemsItem>; total_count: number }

Type declaration

SearchCodeResponseDataItemsItem

SearchCodeResponseDataItemsItem: { git_url: string; html_url: string; name: string; path: string; repository: SearchCodeResponseDataItemsItemRepository; score: number; sha: string; url: string }

Type declaration

SearchCodeResponseDataItemsItemRepository

SearchCodeResponseDataItemsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: SearchCodeResponseDataItemsItemRepositoryOwner; private: boolean; pulls_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: SearchCodeResponseDataItemsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

SearchCodeResponseDataItemsItemRepositoryOwner

SearchCodeResponseDataItemsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchCommitsEndpoint

SearchCommitsEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "author-date" | "committer-date" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.

  • Optional sort?: "author-date" | "committer-date"

    Sorts the results of your query by author-date or committer-date. Default: best match

SearchCommitsRequestOptions

SearchCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/commits" }

Type declaration

SearchCommitsResponseData

SearchCommitsResponseData: { incomplete_results: boolean; items: Array<SearchCommitsResponseDataItemsItem>; total_count: number }

Type declaration

SearchCommitsResponseDataItemsItem

SearchCommitsResponseDataItemsItem: { author: SearchCommitsResponseDataItemsItemAuthor; comments_url: string; commit: SearchCommitsResponseDataItemsItemCommit; committer: SearchCommitsResponseDataItemsItemCommitter; html_url: string; parents: Array<SearchCommitsResponseDataItemsItemParentsItem>; repository: SearchCommitsResponseDataItemsItemRepository; score: number; sha: string; url: string }

Type declaration

SearchCommitsResponseDataItemsItemAuthor

SearchCommitsResponseDataItemsItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchCommitsResponseDataItemsItemCommit

SearchCommitsResponseDataItemsItemCommit: { author: SearchCommitsResponseDataItemsItemCommitAuthor; comment_count: number; committer: SearchCommitsResponseDataItemsItemCommitCommitter; message: string; tree: SearchCommitsResponseDataItemsItemCommitTree; url: string }

Type declaration

SearchCommitsResponseDataItemsItemCommitAuthor

SearchCommitsResponseDataItemsItemCommitAuthor: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

SearchCommitsResponseDataItemsItemCommitCommitter

SearchCommitsResponseDataItemsItemCommitCommitter: { date: string; email: string; name: string }

Type declaration

  • date: string
  • email: string
  • name: string

SearchCommitsResponseDataItemsItemCommitTree

SearchCommitsResponseDataItemsItemCommitTree: { sha: string; url: string }

Type declaration

  • sha: string
  • url: string

SearchCommitsResponseDataItemsItemCommitter

SearchCommitsResponseDataItemsItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchCommitsResponseDataItemsItemParentsItem

SearchCommitsResponseDataItemsItemParentsItem: { html_url: string; sha: string; url: string }

Type declaration

  • html_url: string
  • sha: string
  • url: string

SearchCommitsResponseDataItemsItemRepository

SearchCommitsResponseDataItemsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: SearchCommitsResponseDataItemsItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: SearchCommitsResponseDataItemsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

SearchCommitsResponseDataItemsItemRepositoryOwner

SearchCommitsResponseDataItemsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchEmailLegacyEndpoint

SearchEmailLegacyEndpoint: { email: string }

Type declaration

  • email: string

    The email address.

SearchEmailLegacyRequestOptions

SearchEmailLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/legacy/user/email/:email" }

Type declaration

SearchEmailLegacyResponseData

SearchEmailLegacyResponseData: { user: SearchEmailLegacyResponseDataUser }

Type declaration

SearchEmailLegacyResponseDataUser

SearchEmailLegacyResponseDataUser: { blog: string; company: string; created: string; created_at: string; email: string; followers_count: number; following_count: number; gravatar_id: string; id: number; location: string; login: string; name: string; public_gist_count: number; public_repo_count: number; type: string }

Type declaration

  • blog: string
  • company: string
  • created: string
  • created_at: string
  • email: string
  • followers_count: number
  • following_count: number
  • gravatar_id: string
  • id: number
  • location: string
  • login: string
  • name: string
  • public_gist_count: number
  • public_repo_count: number
  • type: string

SearchIssuesAndPullRequestsEndpoint

SearchIssuesAndPullRequestsEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

  • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

    Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

SearchIssuesAndPullRequestsRequestOptions

SearchIssuesAndPullRequestsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/issues" }

Type declaration

SearchIssuesAndPullRequestsResponseData

SearchIssuesAndPullRequestsResponseData: { incomplete_results: boolean; items: Array<SearchIssuesAndPullRequestsResponseDataItemsItem>; total_count: number }

Type declaration

SearchIssuesAndPullRequestsResponseDataItemsItem

SearchIssuesAndPullRequestsResponseDataItemsItem: { assignee: null; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<SearchIssuesAndPullRequestsResponseDataItemsItemLabelsItem>; labels_url: string; milestone: null; node_id: string; number: number; pull_request: SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest; repository_url: string; score: number; state: string; title: string; updated_at: string; url: string; user: SearchIssuesAndPullRequestsResponseDataItemsItemUser }

Type declaration

SearchIssuesAndPullRequestsResponseDataItemsItemLabelsItem

SearchIssuesAndPullRequestsResponseDataItemsItemLabelsItem: { color: string; id: number; name: string; node_id: string; url: string }

Type declaration

  • color: string
  • id: number
  • name: string
  • node_id: string
  • url: string

SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest

SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest: { diff_url: null; html_url: null; patch_url: null }

Type declaration

  • diff_url: null
  • html_url: null
  • patch_url: null

SearchIssuesAndPullRequestsResponseDataItemsItemUser

SearchIssuesAndPullRequestsResponseDataItemsItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchIssuesLegacyEndpoint

SearchIssuesLegacyEndpoint: { keyword: string; owner: string; repository: string; state: "open" | "closed" }

Type declaration

  • keyword: string

    The search term.

  • owner: string

    owner parameter

  • repository: string

    repository parameter

  • state: "open" | "closed"

    Indicates the state of the issues to return. Can be either open or closed.

SearchIssuesLegacyRequestOptions

SearchIssuesLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/legacy/issues/search/:owner/:repository/:state/:keyword" }

Type declaration

SearchIssuesLegacyResponseData

SearchIssuesLegacyResponseData: { issues: Array<SearchIssuesLegacyResponseDataIssuesItem> }

Type declaration

SearchIssuesLegacyResponseDataIssuesItem

SearchIssuesLegacyResponseDataIssuesItem: { body: string; comments: number; created_at: string; gravatar_id: string; html_url: string; labels: Array<string>; number: number; position: number; state: string; title: string; updated_at: string; user: string; votes: number }

Type declaration

  • body: string
  • comments: number
  • created_at: string
  • gravatar_id: string
  • html_url: string
  • labels: Array<string>
  • number: number
  • position: number
  • state: string
  • title: string
  • updated_at: string
  • user: string
  • votes: number

SearchLabelsEndpoint

SearchLabelsEndpoint: { order?: "desc" | "asc"; q: string; repository_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • q: string

    The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

  • repository_id: number

    The id of the repository.

  • Optional sort?: "created" | "updated"

    Sorts the results of your query by when the label was created or updated. Default: best match

SearchLabelsRequestOptions

SearchLabelsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/labels" }

Type declaration

SearchLabelsResponseData

SearchLabelsResponseData: { incomplete_results: boolean; items: Array<SearchLabelsResponseDataItemsItem>; total_count: number }

Type declaration

SearchLabelsResponseDataItemsItem

SearchLabelsResponseDataItemsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; score: number; url: string }

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • score: number
  • url: string

SearchReposEndpoint

SearchReposEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "stars" | "forks" | "help-wanted-issues" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

  • Optional sort?: "stars" | "forks" | "help-wanted-issues" | "updated"

    Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

SearchReposLegacyEndpoint

SearchReposLegacyEndpoint: { keyword: string; language?: string; order?: "asc" | "desc"; sort?: "stars" | "forks" | "updated"; start_page?: string }

Type declaration

  • keyword: string

    The search term.

  • Optional language?: string

    Filter results by language.

  • Optional order?: "asc" | "desc"

    The sort field. if sort param is provided. Can be either asc or desc.

  • Optional sort?: "stars" | "forks" | "updated"

    The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

  • Optional start_page?: string

    The page number to fetch.

SearchReposLegacyRequestOptions

SearchReposLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/legacy/repos/search/:keyword" }

Type declaration

SearchReposLegacyResponseData

SearchReposLegacyResponseData: { repositories: Array<SearchReposLegacyResponseDataRepositoriesItem> }

Type declaration

SearchReposLegacyResponseDataRepositoriesItem

SearchReposLegacyResponseDataRepositoriesItem: { created: string; created_at: string; description: string; followers: number; fork: boolean; forks: number; has_downloads: boolean; has_issues: boolean; has_wiki: boolean; homepage: string; language: string; name: string; open_issues: number; owner: string; private: boolean; pushed: string; pushed_at: string; score: number; size: number; type: string; url: string; username: string; watchers: number }

Type declaration

  • created: string
  • created_at: string
  • description: string
  • followers: number
  • fork: boolean
  • forks: number
  • has_downloads: boolean
  • has_issues: boolean
  • has_wiki: boolean
  • homepage: string
  • language: string
  • name: string
  • open_issues: number
  • owner: string
  • private: boolean
  • pushed: string
  • pushed_at: string
  • score: number
  • size: number
  • type: string
  • url: string
  • username: string
  • watchers: number

SearchReposRequestOptions

SearchReposRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/repositories" }

Type declaration

SearchReposResponseData

SearchReposResponseData: { incomplete_results: boolean; items: Array<SearchReposResponseDataItemsItem>; total_count: number }

Type declaration

SearchReposResponseDataItemsItem

SearchReposResponseDataItemsItem: { created_at: string; default_branch: string; description: string; fork: boolean; forks_count: number; full_name: string; homepage: string; html_url: string; id: number; language: string; master_branch: string; name: string; node_id: string; open_issues_count: number; owner: SearchReposResponseDataItemsItemOwner; private: boolean; pushed_at: string; score: number; size: number; stargazers_count: number; updated_at: string; url: string; watchers_count: number }

Type declaration

  • created_at: string
  • default_branch: string
  • description: string
  • fork: boolean
  • forks_count: number
  • full_name: string
  • homepage: string
  • html_url: string
  • id: number
  • language: string
  • master_branch: string
  • name: string
  • node_id: string
  • open_issues_count: number
  • owner: SearchReposResponseDataItemsItemOwner
  • private: boolean
  • pushed_at: string
  • score: number
  • size: number
  • stargazers_count: number
  • updated_at: string
  • url: string
  • watchers_count: number

SearchReposResponseDataItemsItemOwner

SearchReposResponseDataItemsItemOwner: { avatar_url: string; gravatar_id: string; id: number; login: string; node_id: string; received_events_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • gravatar_id: string
  • id: number
  • login: string
  • node_id: string
  • received_events_url: string
  • type: string
  • url: string

SearchTopicsEndpoint

SearchTopicsEndpoint: { q: string }

Type declaration

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query.

SearchTopicsRequestOptions

SearchTopicsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/topics" }

Type declaration

SearchTopicsResponseData

SearchTopicsResponseData: { incomplete_results: boolean; items: Array<SearchTopicsResponseDataItemsItem>; total_count: number }

Type declaration

SearchTopicsResponseDataItemsItem

SearchTopicsResponseDataItemsItem: { created_at: string; created_by: string; curated: boolean; description: string; display_name: string; featured: boolean; name: string; released: string; score: number; short_description: string; updated_at: string }

Type declaration

  • created_at: string
  • created_by: string
  • curated: boolean
  • description: string
  • display_name: string
  • featured: boolean
  • name: string
  • released: string
  • score: number
  • short_description: string
  • updated_at: string

SearchUsersEndpoint

SearchUsersEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "followers" | "repositories" | "joined" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.

  • Optional sort?: "followers" | "repositories" | "joined"

    Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match

SearchUsersLegacyEndpoint

SearchUsersLegacyEndpoint: { keyword: string; order?: "asc" | "desc"; sort?: "stars" | "forks" | "updated"; start_page?: string }

Type declaration

  • keyword: string

    The search term.

  • Optional order?: "asc" | "desc"

    The sort field. if sort param is provided. Can be either asc or desc.

  • Optional sort?: "stars" | "forks" | "updated"

    The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

  • Optional start_page?: string

    The page number to fetch.

SearchUsersLegacyRequestOptions

SearchUsersLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/legacy/user/search/:keyword" }

Type declaration

SearchUsersLegacyResponseData

SearchUsersLegacyResponseData: { users: Array<SearchUsersLegacyResponseDataUsersItem> }

Type declaration

SearchUsersLegacyResponseDataUsersItem

SearchUsersLegacyResponseDataUsersItem: { created: string; created_at: string; followers: number; followers_count: number; fullname: string; gravatar_id: string; id: string; language: string; location: string; login: string; name: string; public_repo_count: number; repos: number; score: number; type: string; username: string }

Type declaration

  • created: string
  • created_at: string
  • followers: number
  • followers_count: number
  • fullname: string
  • gravatar_id: string
  • id: string
  • language: string
  • location: string
  • login: string
  • name: string
  • public_repo_count: number
  • repos: number
  • score: number
  • type: string
  • username: string

SearchUsersRequestOptions

SearchUsersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/users" }

Type declaration

SearchUsersResponseData

SearchUsersResponseData: { incomplete_results: boolean; items: Array<SearchUsersResponseDataItemsItem>; total_count: number }

Type declaration

SearchUsersResponseDataItemsItem

SearchUsersResponseDataItemsItem: { avatar_url: string; followers_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; score: number; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • followers_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • score: number
  • subscriptions_url: string
  • type: string
  • url: string

TeamsAddMemberLegacyEndpoint

TeamsAddMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsAddMemberLegacyRequestOptions

TeamsAddMemberLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/members/:username" }

Type declaration

TeamsAddMemberLegacyResponseData

TeamsAddMemberLegacyResponseData: { errors: Array<TeamsAddMemberLegacyResponseDataErrorsItem>; message: string }

Type declaration

TeamsAddMemberLegacyResponseDataErrorsItem

TeamsAddMemberLegacyResponseDataErrorsItem: { code: string; field: string; resource: string }

Type declaration

  • code: string
  • field: string
  • resource: string

TeamsAddOrUpdateMembershipInOrgEndpoint

TeamsAddOrUpdateMembershipInOrgEndpoint: { org: string; role?: "member" | "maintainer"; team_slug: string; username: string }

Type declaration

  • org: string

    org parameter

  • Optional role?: "member" | "maintainer"

    The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

  • team_slug: string

    team_slug parameter

  • username: string

    username parameter

TeamsAddOrUpdateMembershipInOrgRequestOptions

TeamsAddOrUpdateMembershipInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/memberships/:username" }

Type declaration

TeamsAddOrUpdateMembershipInOrgResponseData

TeamsAddOrUpdateMembershipInOrgResponseData: { role: string; state: string; url: string }

Type declaration

  • role: string
  • state: string
  • url: string

TeamsAddOrUpdateMembershipLegacyEndpoint

TeamsAddOrUpdateMembershipLegacyEndpoint: { role?: "member" | "maintainer"; team_id: number; username: string }

Type declaration

  • Optional role?: "member" | "maintainer"

    The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsAddOrUpdateMembershipLegacyRequestOptions

TeamsAddOrUpdateMembershipLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/memberships/:username" }

Type declaration

TeamsAddOrUpdateMembershipLegacyResponseData

TeamsAddOrUpdateMembershipLegacyResponseData: { role: string; state: string; url: string }

Type declaration

  • role: string
  • state: string
  • url: string

TeamsAddOrUpdateProjectInOrgEndpoint

TeamsAddOrUpdateProjectInOrgEndpoint: { org: string; permission?: "read" | "write" | "admin"; project_id: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

  • project_id: number

    project_id parameter

  • team_slug: string

    team_slug parameter

TeamsAddOrUpdateProjectInOrgRequestOptions

TeamsAddOrUpdateProjectInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects/:project_id" }

Type declaration

TeamsAddOrUpdateProjectInOrgResponseData

TeamsAddOrUpdateProjectInOrgResponseData: { documentation_url: string; message: string }

Type declaration

  • documentation_url: string
  • message: string

TeamsAddOrUpdateProjectLegacyEndpoint

TeamsAddOrUpdateProjectLegacyEndpoint: { permission?: "read" | "write" | "admin"; project_id: number; team_id: number }

Type declaration

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsAddOrUpdateProjectLegacyRequestOptions

TeamsAddOrUpdateProjectLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/projects/:project_id" }

Type declaration

TeamsAddOrUpdateProjectLegacyResponseData

TeamsAddOrUpdateProjectLegacyResponseData: { documentation_url: string; message: string }

Type declaration

  • documentation_url: string
  • message: string

TeamsAddOrUpdateRepoInOrgEndpoint

TeamsAddOrUpdateRepoInOrgEndpoint: { org: string; owner: string; permission?: "pull" | "push" | "admin" | "maintain" | "triage"; repo: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • owner: string

    owner parameter

  • Optional permission?: "pull" | "push" | "admin" | "maintain" | "triage"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository. * maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. * triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

  • repo: string

    repo parameter

  • team_slug: string

    team_slug parameter

TeamsAddOrUpdateRepoInOrgRequestOptions

TeamsAddOrUpdateRepoInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" }

Type declaration

TeamsAddOrUpdateRepoLegacyEndpoint

TeamsAddOrUpdateRepoLegacyEndpoint: { owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional permission?: "pull" | "push" | "admin"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsAddOrUpdateRepoLegacyRequestOptions

TeamsAddOrUpdateRepoLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/repos/:owner/:repo" }

Type declaration

TeamsCheckManagesRepoInOrgEndpoint

TeamsCheckManagesRepoInOrgEndpoint: { org: string; owner: string; repo: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_slug: string

    team_slug parameter

TeamsCheckManagesRepoInOrgRequestOptions

TeamsCheckManagesRepoInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" }

Type declaration

TeamsCheckManagesRepoInOrgResponseData

TeamsCheckManagesRepoInOrgResponseData: { organization: TeamsCheckManagesRepoInOrgResponseDataOrganization; parent: TeamsCheckManagesRepoInOrgResponseDataParent; permissions: TeamsCheckManagesRepoInOrgResponseDataPermissions; source: TeamsCheckManagesRepoInOrgResponseDataSource }

Type declaration

TeamsCheckManagesRepoInOrgResponseDataOrganization

TeamsCheckManagesRepoInOrgResponseDataOrganization: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCheckManagesRepoInOrgResponseDataParent

TeamsCheckManagesRepoInOrgResponseDataParent: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsCheckManagesRepoInOrgResponseDataParentOwner; permissions: TeamsCheckManagesRepoInOrgResponseDataParentPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: TeamsCheckManagesRepoInOrgResponseDataParentOwner
  • permissions: TeamsCheckManagesRepoInOrgResponseDataParentPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

TeamsCheckManagesRepoInOrgResponseDataParentOwner

TeamsCheckManagesRepoInOrgResponseDataParentOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCheckManagesRepoInOrgResponseDataParentPermissions

TeamsCheckManagesRepoInOrgResponseDataParentPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsCheckManagesRepoInOrgResponseDataPermissions

TeamsCheckManagesRepoInOrgResponseDataPermissions: { admin: boolean; maintain: boolean; pull: boolean; push: boolean; triage: boolean }

Type declaration

  • admin: boolean
  • maintain: boolean
  • pull: boolean
  • push: boolean
  • triage: boolean

TeamsCheckManagesRepoInOrgResponseDataSource

TeamsCheckManagesRepoInOrgResponseDataSource: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsCheckManagesRepoInOrgResponseDataSourceOwner; permissions: TeamsCheckManagesRepoInOrgResponseDataSourcePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: TeamsCheckManagesRepoInOrgResponseDataSourceOwner
  • permissions: TeamsCheckManagesRepoInOrgResponseDataSourcePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

TeamsCheckManagesRepoInOrgResponseDataSourceOwner

TeamsCheckManagesRepoInOrgResponseDataSourceOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCheckManagesRepoInOrgResponseDataSourcePermissions

TeamsCheckManagesRepoInOrgResponseDataSourcePermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsCheckManagesRepoLegacyEndpoint

TeamsCheckManagesRepoLegacyEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsCheckManagesRepoLegacyRequestOptions

TeamsCheckManagesRepoLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/repos/:owner/:repo" }

Type declaration

TeamsCheckManagesRepoLegacyResponseData

TeamsCheckManagesRepoLegacyResponseData: { organization: TeamsCheckManagesRepoLegacyResponseDataOrganization; parent: TeamsCheckManagesRepoLegacyResponseDataParent; permissions: TeamsCheckManagesRepoLegacyResponseDataPermissions; source: TeamsCheckManagesRepoLegacyResponseDataSource }

Type declaration

TeamsCheckManagesRepoLegacyResponseDataOrganization

TeamsCheckManagesRepoLegacyResponseDataOrganization: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCheckManagesRepoLegacyResponseDataParent

TeamsCheckManagesRepoLegacyResponseDataParent: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsCheckManagesRepoLegacyResponseDataParentOwner; permissions: TeamsCheckManagesRepoLegacyResponseDataParentPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: TeamsCheckManagesRepoLegacyResponseDataParentOwner
  • permissions: TeamsCheckManagesRepoLegacyResponseDataParentPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

TeamsCheckManagesRepoLegacyResponseDataParentOwner

TeamsCheckManagesRepoLegacyResponseDataParentOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCheckManagesRepoLegacyResponseDataParentPermissions

TeamsCheckManagesRepoLegacyResponseDataParentPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsCheckManagesRepoLegacyResponseDataPermissions

TeamsCheckManagesRepoLegacyResponseDataPermissions: { admin: boolean; maintain: boolean; pull: boolean; push: boolean; triage: boolean }

Type declaration

  • admin: boolean
  • maintain: boolean
  • pull: boolean
  • push: boolean
  • triage: boolean

TeamsCheckManagesRepoLegacyResponseDataSource

TeamsCheckManagesRepoLegacyResponseDataSource: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsCheckManagesRepoLegacyResponseDataSourceOwner; permissions: TeamsCheckManagesRepoLegacyResponseDataSourcePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: TeamsCheckManagesRepoLegacyResponseDataSourceOwner
  • permissions: TeamsCheckManagesRepoLegacyResponseDataSourcePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

TeamsCheckManagesRepoLegacyResponseDataSourceOwner

TeamsCheckManagesRepoLegacyResponseDataSourceOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCheckManagesRepoLegacyResponseDataSourcePermissions

TeamsCheckManagesRepoLegacyResponseDataSourcePermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsCreateDiscussionCommentInOrgEndpoint

TeamsCreateDiscussionCommentInOrgEndpoint: { body: string; discussion_number: number; org: string; team_slug: string }

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsCreateDiscussionCommentInOrgRequestOptions

TeamsCreateDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments" }

Type declaration

TeamsCreateDiscussionCommentInOrgResponseData

TeamsCreateDiscussionCommentInOrgResponseData: { author: TeamsCreateDiscussionCommentInOrgResponseDataAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsCreateDiscussionCommentInOrgResponseDataReactions; updated_at: string; url: string }

Type declaration

TeamsCreateDiscussionCommentInOrgResponseDataAuthor

TeamsCreateDiscussionCommentInOrgResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCreateDiscussionCommentInOrgResponseDataReactions

TeamsCreateDiscussionCommentInOrgResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsCreateDiscussionCommentLegacyEndpoint

TeamsCreateDiscussionCommentLegacyEndpoint: { body: string; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsCreateDiscussionCommentLegacyRequestOptions

TeamsCreateDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments" }

Type declaration

TeamsCreateDiscussionCommentLegacyResponseData

TeamsCreateDiscussionCommentLegacyResponseData: { author: TeamsCreateDiscussionCommentLegacyResponseDataAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsCreateDiscussionCommentLegacyResponseDataReactions; updated_at: string; url: string }

Type declaration

TeamsCreateDiscussionCommentLegacyResponseDataAuthor

TeamsCreateDiscussionCommentLegacyResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCreateDiscussionCommentLegacyResponseDataReactions

TeamsCreateDiscussionCommentLegacyResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsCreateDiscussionInOrgEndpoint

TeamsCreateDiscussionInOrgEndpoint: { body: string; org: string; private?: boolean; team_slug: string; title: string }

Type declaration

  • body: string

    The discussion post's body text.

  • org: string

    org parameter

  • Optional private?: boolean

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_slug: string

    team_slug parameter

  • title: string

    The discussion post's title.

TeamsCreateDiscussionInOrgRequestOptions

TeamsCreateDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions" }

Type declaration

TeamsCreateDiscussionInOrgResponseData

TeamsCreateDiscussionInOrgResponseData: { author: TeamsCreateDiscussionInOrgResponseDataAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsCreateDiscussionInOrgResponseDataReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsCreateDiscussionInOrgResponseDataAuthor

TeamsCreateDiscussionInOrgResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCreateDiscussionInOrgResponseDataReactions

TeamsCreateDiscussionInOrgResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsCreateDiscussionLegacyEndpoint

TeamsCreateDiscussionLegacyEndpoint: { body: string; private?: boolean; team_id: number; title: string }

Type declaration

  • body: string

    The discussion post's body text.

  • Optional private?: boolean

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_id: number

    team_id parameter

  • title: string

    The discussion post's title.

TeamsCreateDiscussionLegacyRequestOptions

TeamsCreateDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions" }

Type declaration

TeamsCreateDiscussionLegacyResponseData

TeamsCreateDiscussionLegacyResponseData: { author: TeamsCreateDiscussionLegacyResponseDataAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsCreateDiscussionLegacyResponseDataReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsCreateDiscussionLegacyResponseDataAuthor

TeamsCreateDiscussionLegacyResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCreateDiscussionLegacyResponseDataReactions

TeamsCreateDiscussionLegacyResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsCreateEndpoint

TeamsCreateEndpoint: { description?: string; maintainers?: string[]; name: string; org: string; parent_team_id?: number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; repo_names?: string[] }

Type declaration

  • Optional description?: string

    The description of the team.

  • Optional maintainers?: string[]

    List GitHub IDs for organization members who will become team maintainers.

  • name: string

    The name of the team.

  • org: string

    org parameter

  • Optional parent_team_id?: number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed

  • Optional repo_names?: string[]

    The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint: { groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]; org: string; team_slug: string }

Type declaration

  • groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings" }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData: { groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint: { groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]; team_id: number }

Type declaration

  • groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

  • team_id: number

    team_id parameter

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id/team-sync/group-mappings" }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData: { groups: Array<TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem> }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateRequestOptions

TeamsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams" }

Type declaration

TeamsCreateResponseData

TeamsCreateResponseData: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsCreateResponseDataOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • description: string
  • html_url: string
  • id: number
  • members_count: number
  • members_url: string
  • name: string
  • node_id: string
  • organization: TeamsCreateResponseDataOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsCreateResponseDataOrganization

TeamsCreateResponseDataOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • blog: string
  • company: string
  • created_at: string
  • description: string
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • members_url: string
  • name: string
  • node_id: string
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • type: string
  • url: string

TeamsDeleteDiscussionCommentInOrgEndpoint

TeamsDeleteDiscussionCommentInOrgEndpoint: { comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsDeleteDiscussionCommentInOrgRequestOptions

TeamsDeleteDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsDeleteDiscussionCommentLegacyEndpoint

TeamsDeleteDiscussionCommentLegacyEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsDeleteDiscussionCommentLegacyRequestOptions

TeamsDeleteDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsDeleteDiscussionInOrgEndpoint

TeamsDeleteDiscussionInOrgEndpoint: { discussion_number: number; org: string; team_slug: string }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsDeleteDiscussionInOrgRequestOptions

TeamsDeleteDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" }

Type declaration

TeamsDeleteDiscussionLegacyEndpoint

TeamsDeleteDiscussionLegacyEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsDeleteDiscussionLegacyRequestOptions

TeamsDeleteDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number" }

Type declaration

TeamsDeleteInOrgEndpoint

TeamsDeleteInOrgEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsDeleteInOrgRequestOptions

TeamsDeleteInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug" }

Type declaration

TeamsDeleteLegacyEndpoint

TeamsDeleteLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsDeleteLegacyRequestOptions

TeamsDeleteLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id" }

Type declaration

TeamsGetByNameEndpoint

TeamsGetByNameEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsGetByNameRequestOptions

TeamsGetByNameRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug" }

Type declaration

TeamsGetByNameResponseData

TeamsGetByNameResponseData: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsGetByNameResponseDataOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • description: string
  • html_url: string
  • id: number
  • members_count: number
  • members_url: string
  • name: string
  • node_id: string
  • organization: TeamsGetByNameResponseDataOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsGetByNameResponseDataOrganization

TeamsGetByNameResponseDataOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • blog: string
  • company: string
  • created_at: string
  • description: string
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • members_url: string
  • name: string
  • node_id: string
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • type: string
  • url: string

TeamsGetDiscussionCommentInOrgEndpoint

TeamsGetDiscussionCommentInOrgEndpoint: { comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsGetDiscussionCommentInOrgRequestOptions

TeamsGetDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsGetDiscussionCommentInOrgResponseData

TeamsGetDiscussionCommentInOrgResponseData: { author: TeamsGetDiscussionCommentInOrgResponseDataAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsGetDiscussionCommentInOrgResponseDataReactions; updated_at: string; url: string }

Type declaration

TeamsGetDiscussionCommentInOrgResponseDataAuthor

TeamsGetDiscussionCommentInOrgResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsGetDiscussionCommentInOrgResponseDataReactions

TeamsGetDiscussionCommentInOrgResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsGetDiscussionCommentLegacyEndpoint

TeamsGetDiscussionCommentLegacyEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsGetDiscussionCommentLegacyRequestOptions

TeamsGetDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsGetDiscussionCommentLegacyResponseData

TeamsGetDiscussionCommentLegacyResponseData: { author: TeamsGetDiscussionCommentLegacyResponseDataAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsGetDiscussionCommentLegacyResponseDataReactions; updated_at: string; url: string }

Type declaration

TeamsGetDiscussionCommentLegacyResponseDataAuthor

TeamsGetDiscussionCommentLegacyResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsGetDiscussionCommentLegacyResponseDataReactions

TeamsGetDiscussionCommentLegacyResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsGetDiscussionInOrgEndpoint

TeamsGetDiscussionInOrgEndpoint: { discussion_number: number; org: string; team_slug: string }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsGetDiscussionInOrgRequestOptions

TeamsGetDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" }

Type declaration

TeamsGetDiscussionInOrgResponseData

TeamsGetDiscussionInOrgResponseData: { author: TeamsGetDiscussionInOrgResponseDataAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsGetDiscussionInOrgResponseDataReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsGetDiscussionInOrgResponseDataAuthor

TeamsGetDiscussionInOrgResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsGetDiscussionInOrgResponseDataReactions

TeamsGetDiscussionInOrgResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsGetDiscussionLegacyEndpoint

TeamsGetDiscussionLegacyEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsGetDiscussionLegacyRequestOptions

TeamsGetDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number" }

Type declaration

TeamsGetDiscussionLegacyResponseData

TeamsGetDiscussionLegacyResponseData: { author: TeamsGetDiscussionLegacyResponseDataAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsGetDiscussionLegacyResponseDataReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsGetDiscussionLegacyResponseDataAuthor

TeamsGetDiscussionLegacyResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsGetDiscussionLegacyResponseDataReactions

TeamsGetDiscussionLegacyResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsGetLegacyEndpoint

TeamsGetLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsGetLegacyRequestOptions

TeamsGetLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id" }

Type declaration

TeamsGetLegacyResponseData

TeamsGetLegacyResponseData: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsGetLegacyResponseDataOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • description: string
  • html_url: string
  • id: number
  • members_count: number
  • members_url: string
  • name: string
  • node_id: string
  • organization: TeamsGetLegacyResponseDataOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsGetLegacyResponseDataOrganization

TeamsGetLegacyResponseDataOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • blog: string
  • company: string
  • created_at: string
  • description: string
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • members_url: string
  • name: string
  • node_id: string
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • type: string
  • url: string

TeamsGetMemberLegacyEndpoint

TeamsGetMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsGetMemberLegacyRequestOptions

TeamsGetMemberLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/members/:username" }

Type declaration

TeamsGetMembershipInOrgEndpoint

TeamsGetMembershipInOrgEndpoint: { org: string; team_slug: string; username: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

  • username: string

    username parameter

TeamsGetMembershipInOrgRequestOptions

TeamsGetMembershipInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/memberships/:username" }

Type declaration

TeamsGetMembershipInOrgResponseData

TeamsGetMembershipInOrgResponseData: { role: string; state: string; url: string }

Type declaration

  • role: string
  • state: string
  • url: string

TeamsGetMembershipLegacyEndpoint

TeamsGetMembershipLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsGetMembershipLegacyRequestOptions

TeamsGetMembershipLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/memberships/:username" }

Type declaration

TeamsGetMembershipLegacyResponseData

TeamsGetMembershipLegacyResponseData: { role: string; state: string; url: string }

Type declaration

  • role: string
  • state: string
  • url: string

TeamsListChildInOrgEndpoint

TeamsListChildInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListChildInOrgRequestOptions

TeamsListChildInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/teams" }

Type declaration

TeamsListChildInOrgResponseData

TeamsListChildInOrgResponseData: Array<TeamsListChildInOrgResponseDataItem>

TeamsListChildInOrgResponseDataItem

TeamsListChildInOrgResponseDataItem: { description: string; id: number; members_url: string; name: string; node_id: string; parent: TeamsListChildInOrgResponseDataItemParent; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: TeamsListChildInOrgResponseDataItemParent
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

TeamsListChildInOrgResponseDataItemParent

TeamsListChildInOrgResponseDataItemParent: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

TeamsListChildLegacyEndpoint

TeamsListChildLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListChildLegacyRequestOptions

TeamsListChildLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/teams" }

Type declaration

TeamsListChildLegacyResponseData

TeamsListChildLegacyResponseData: Array<TeamsListChildLegacyResponseDataItem>

TeamsListChildLegacyResponseDataItem

TeamsListChildLegacyResponseDataItem: { description: string; id: number; members_url: string; name: string; node_id: string; parent: TeamsListChildLegacyResponseDataItemParent; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: TeamsListChildLegacyResponseDataItemParent
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

TeamsListChildLegacyResponseDataItemParent

TeamsListChildLegacyResponseDataItemParent: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

TeamsListDiscussionCommentsInOrgEndpoint

TeamsListDiscussionCommentsInOrgEndpoint: { direction?: "asc" | "desc"; discussion_number: number; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListDiscussionCommentsInOrgRequestOptions

TeamsListDiscussionCommentsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments" }

Type declaration

TeamsListDiscussionCommentsInOrgResponseData

TeamsListDiscussionCommentsInOrgResponseData: Array<TeamsListDiscussionCommentsInOrgResponseDataItem>

TeamsListDiscussionCommentsInOrgResponseDataItem

TeamsListDiscussionCommentsInOrgResponseDataItem: { author: TeamsListDiscussionCommentsInOrgResponseDataItemAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsListDiscussionCommentsInOrgResponseDataItemReactions; updated_at: string; url: string }

Type declaration

TeamsListDiscussionCommentsInOrgResponseDataItemAuthor

TeamsListDiscussionCommentsInOrgResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListDiscussionCommentsInOrgResponseDataItemReactions

TeamsListDiscussionCommentsInOrgResponseDataItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsListDiscussionCommentsLegacyEndpoint

TeamsListDiscussionCommentsLegacyEndpoint: { direction?: "asc" | "desc"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListDiscussionCommentsLegacyRequestOptions

TeamsListDiscussionCommentsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments" }

Type declaration

TeamsListDiscussionCommentsLegacyResponseData

TeamsListDiscussionCommentsLegacyResponseData: Array<TeamsListDiscussionCommentsLegacyResponseDataItem>

TeamsListDiscussionCommentsLegacyResponseDataItem

TeamsListDiscussionCommentsLegacyResponseDataItem: { author: TeamsListDiscussionCommentsLegacyResponseDataItemAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsListDiscussionCommentsLegacyResponseDataItemReactions; updated_at: string; url: string }

Type declaration

TeamsListDiscussionCommentsLegacyResponseDataItemAuthor

TeamsListDiscussionCommentsLegacyResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListDiscussionCommentsLegacyResponseDataItemReactions

TeamsListDiscussionCommentsLegacyResponseDataItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsListDiscussionsInOrgEndpoint

TeamsListDiscussionsInOrgEndpoint: { direction?: "asc" | "desc"; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListDiscussionsInOrgRequestOptions

TeamsListDiscussionsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions" }

Type declaration

TeamsListDiscussionsInOrgResponseData

TeamsListDiscussionsInOrgResponseData: Array<TeamsListDiscussionsInOrgResponseDataItem>

TeamsListDiscussionsInOrgResponseDataItem

TeamsListDiscussionsInOrgResponseDataItem: { author: TeamsListDiscussionsInOrgResponseDataItemAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsListDiscussionsInOrgResponseDataItemReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsListDiscussionsInOrgResponseDataItemAuthor

TeamsListDiscussionsInOrgResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListDiscussionsInOrgResponseDataItemReactions

TeamsListDiscussionsInOrgResponseDataItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsListDiscussionsLegacyEndpoint

TeamsListDiscussionsLegacyEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListDiscussionsLegacyRequestOptions

TeamsListDiscussionsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions" }

Type declaration

TeamsListDiscussionsLegacyResponseData

TeamsListDiscussionsLegacyResponseData: Array<TeamsListDiscussionsLegacyResponseDataItem>

TeamsListDiscussionsLegacyResponseDataItem

TeamsListDiscussionsLegacyResponseDataItem: { author: TeamsListDiscussionsLegacyResponseDataItemAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsListDiscussionsLegacyResponseDataItemReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsListDiscussionsLegacyResponseDataItemAuthor

TeamsListDiscussionsLegacyResponseDataItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListDiscussionsLegacyResponseDataItemReactions

TeamsListDiscussionsLegacyResponseDataItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsListEndpoint

TeamsListEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

TeamsListForAuthenticatedUserEndpoint

TeamsListForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

TeamsListForAuthenticatedUserRequestOptions

TeamsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/teams" }

Type declaration

TeamsListForAuthenticatedUserResponseData

TeamsListForAuthenticatedUserResponseData: Array<TeamsListForAuthenticatedUserResponseDataItem>

TeamsListForAuthenticatedUserResponseDataItem

TeamsListForAuthenticatedUserResponseDataItem: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsListForAuthenticatedUserResponseDataItemOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • description: string
  • html_url: string
  • id: number
  • members_count: number
  • members_url: string
  • name: string
  • node_id: string
  • organization: TeamsListForAuthenticatedUserResponseDataItemOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsListForAuthenticatedUserResponseDataItemOrganization

TeamsListForAuthenticatedUserResponseDataItemOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • blog: string
  • company: string
  • created_at: string
  • description: string
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • members_url: string
  • name: string
  • node_id: string
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • type: string
  • url: string

TeamsListIdPGroupsForLegacyEndpoint

TeamsListIdPGroupsForLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsListIdPGroupsForLegacyRequestOptions

TeamsListIdPGroupsForLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/team-sync/group-mappings" }

Type declaration

TeamsListIdPGroupsForLegacyResponseData

TeamsListIdPGroupsForLegacyResponseData: { groups: Array<TeamsListIdPGroupsForLegacyResponseDataGroupsItem> }

Type declaration

TeamsListIdPGroupsForLegacyResponseDataGroupsItem

TeamsListIdPGroupsForLegacyResponseDataGroupsItem: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsListIdPGroupsForOrgEndpoint

TeamsListIdPGroupsForOrgEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

TeamsListIdPGroupsForOrgRequestOptions

TeamsListIdPGroupsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/team-sync/groups" }

Type declaration

TeamsListIdPGroupsForOrgResponseData

TeamsListIdPGroupsForOrgResponseData: { groups: Array<TeamsListIdPGroupsForOrgResponseDataGroupsItem> }

Type declaration

TeamsListIdPGroupsForOrgResponseDataGroupsItem

TeamsListIdPGroupsForOrgResponseDataGroupsItem: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsListIdPGroupsInOrgEndpoint

TeamsListIdPGroupsInOrgEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsListIdPGroupsInOrgRequestOptions

TeamsListIdPGroupsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings" }

Type declaration

TeamsListIdPGroupsInOrgResponseData

TeamsListIdPGroupsInOrgResponseData: { groups: Array<TeamsListIdPGroupsInOrgResponseDataGroupsItem> }

Type declaration

TeamsListIdPGroupsInOrgResponseDataGroupsItem

TeamsListIdPGroupsInOrgResponseDataGroupsItem: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsListMembersInOrgEndpoint

TeamsListMembersInOrgEndpoint: { org: string; page?: number; per_page?: number; role?: "member" | "maintainer" | "all"; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_slug: string

    team_slug parameter

TeamsListMembersInOrgRequestOptions

TeamsListMembersInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/members" }

Type declaration

TeamsListMembersInOrgResponseData

TeamsListMembersInOrgResponseData: Array<TeamsListMembersInOrgResponseDataItem>

TeamsListMembersInOrgResponseDataItem

TeamsListMembersInOrgResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListMembersLegacyEndpoint

TeamsListMembersLegacyEndpoint: { page?: number; per_page?: number; role?: "member" | "maintainer" | "all"; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_id: number

    team_id parameter

TeamsListMembersLegacyRequestOptions

TeamsListMembersLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/members" }

Type declaration

TeamsListMembersLegacyResponseData

TeamsListMembersLegacyResponseData: Array<TeamsListMembersLegacyResponseDataItem>

TeamsListMembersLegacyResponseDataItem

TeamsListMembersLegacyResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListPendingInvitationsInOrgEndpoint

TeamsListPendingInvitationsInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListPendingInvitationsInOrgRequestOptions

TeamsListPendingInvitationsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/invitations" }

Type declaration

TeamsListPendingInvitationsInOrgResponseData

TeamsListPendingInvitationsInOrgResponseData: Array<TeamsListPendingInvitationsInOrgResponseDataItem>

TeamsListPendingInvitationsInOrgResponseDataItem

TeamsListPendingInvitationsInOrgResponseDataItem: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: TeamsListPendingInvitationsInOrgResponseDataItemInviter; login: string; role: string; team_count: number }

Type declaration

TeamsListPendingInvitationsInOrgResponseDataItemInviter

TeamsListPendingInvitationsInOrgResponseDataItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListPendingInvitationsLegacyEndpoint

TeamsListPendingInvitationsLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListPendingInvitationsLegacyRequestOptions

TeamsListPendingInvitationsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/invitations" }

Type declaration

TeamsListPendingInvitationsLegacyResponseData

TeamsListPendingInvitationsLegacyResponseData: Array<TeamsListPendingInvitationsLegacyResponseDataItem>

TeamsListPendingInvitationsLegacyResponseDataItem

TeamsListPendingInvitationsLegacyResponseDataItem: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: TeamsListPendingInvitationsLegacyResponseDataItemInviter; login: string; role: string; team_count: number }

Type declaration

TeamsListPendingInvitationsLegacyResponseDataItemInviter

TeamsListPendingInvitationsLegacyResponseDataItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListProjectsInOrgEndpoint

TeamsListProjectsInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListProjectsInOrgRequestOptions

TeamsListProjectsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects" }

Type declaration

TeamsListProjectsInOrgResponseData

TeamsListProjectsInOrgResponseData: Array<TeamsListProjectsInOrgResponseDataItem>

TeamsListProjectsInOrgResponseDataItem

TeamsListProjectsInOrgResponseDataItem: { body: string; columns_url: string; created_at: string; creator: TeamsListProjectsInOrgResponseDataItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsListProjectsInOrgResponseDataItemPermissions; private: boolean; state: string; updated_at: string; url: string }

Type declaration

TeamsListProjectsInOrgResponseDataItemCreator

TeamsListProjectsInOrgResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListProjectsInOrgResponseDataItemPermissions

TeamsListProjectsInOrgResponseDataItemPermissions: { admin: boolean; read: boolean; write: boolean }

Type declaration

  • admin: boolean
  • read: boolean
  • write: boolean

TeamsListProjectsLegacyEndpoint

TeamsListProjectsLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListProjectsLegacyRequestOptions

TeamsListProjectsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/projects" }

Type declaration

TeamsListProjectsLegacyResponseData

TeamsListProjectsLegacyResponseData: Array<TeamsListProjectsLegacyResponseDataItem>

TeamsListProjectsLegacyResponseDataItem

TeamsListProjectsLegacyResponseDataItem: { body: string; columns_url: string; created_at: string; creator: TeamsListProjectsLegacyResponseDataItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsListProjectsLegacyResponseDataItemPermissions; private: boolean; state: string; updated_at: string; url: string }

Type declaration

TeamsListProjectsLegacyResponseDataItemCreator

TeamsListProjectsLegacyResponseDataItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListProjectsLegacyResponseDataItemPermissions

TeamsListProjectsLegacyResponseDataItemPermissions: { admin: boolean; read: boolean; write: boolean }

Type declaration

  • admin: boolean
  • read: boolean
  • write: boolean

TeamsListReposInOrgEndpoint

TeamsListReposInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListReposInOrgRequestOptions

TeamsListReposInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos" }

Type declaration

TeamsListReposInOrgResponseData

TeamsListReposInOrgResponseData: Array<TeamsListReposInOrgResponseDataItem>

TeamsListReposInOrgResponseDataItem

TeamsListReposInOrgResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: TeamsListReposInOrgResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsListReposInOrgResponseDataItemOwner; permissions: TeamsListReposInOrgResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: TeamsListReposInOrgResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: TeamsListReposInOrgResponseDataItemOwner
  • permissions: TeamsListReposInOrgResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

TeamsListReposInOrgResponseDataItemLicense

TeamsListReposInOrgResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

TeamsListReposInOrgResponseDataItemOwner

TeamsListReposInOrgResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListReposInOrgResponseDataItemPermissions

TeamsListReposInOrgResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsListReposLegacyEndpoint

TeamsListReposLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListReposLegacyRequestOptions

TeamsListReposLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/repos" }

Type declaration

TeamsListReposLegacyResponseData

TeamsListReposLegacyResponseData: Array<TeamsListReposLegacyResponseDataItem>

TeamsListReposLegacyResponseDataItem

TeamsListReposLegacyResponseDataItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: TeamsListReposLegacyResponseDataItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsListReposLegacyResponseDataItemOwner; permissions: TeamsListReposLegacyResponseDataItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: TeamsListReposLegacyResponseDataItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: TeamsListReposLegacyResponseDataItemOwner
  • permissions: TeamsListReposLegacyResponseDataItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

TeamsListReposLegacyResponseDataItemLicense

TeamsListReposLegacyResponseDataItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

TeamsListReposLegacyResponseDataItemOwner

TeamsListReposLegacyResponseDataItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListReposLegacyResponseDataItemPermissions

TeamsListReposLegacyResponseDataItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsListRequestOptions

TeamsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams" }

Type declaration

TeamsListResponseData

TeamsListResponseData: Array<TeamsListResponseDataItem>

TeamsListResponseDataItem

TeamsListResponseDataItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

Type declaration

  • description: string
  • html_url: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: null
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

TeamsRemoveMemberLegacyEndpoint

TeamsRemoveMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsRemoveMemberLegacyRequestOptions

TeamsRemoveMemberLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/members/:username" }

Type declaration

TeamsRemoveMembershipInOrgEndpoint

TeamsRemoveMembershipInOrgEndpoint: { org: string; team_slug: string; username: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

  • username: string

    username parameter

TeamsRemoveMembershipInOrgRequestOptions

TeamsRemoveMembershipInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/memberships/:username" }

Type declaration

TeamsRemoveMembershipLegacyEndpoint

TeamsRemoveMembershipLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsRemoveMembershipLegacyRequestOptions

TeamsRemoveMembershipLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/memberships/:username" }

Type declaration

TeamsRemoveProjectInOrgEndpoint

TeamsRemoveProjectInOrgEndpoint: { org: string; project_id: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • project_id: number

    project_id parameter

  • team_slug: string

    team_slug parameter

TeamsRemoveProjectInOrgRequestOptions

TeamsRemoveProjectInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects/:project_id" }

Type declaration

TeamsRemoveProjectLegacyEndpoint

TeamsRemoveProjectLegacyEndpoint: { project_id: number; team_id: number }

Type declaration

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsRemoveProjectLegacyRequestOptions

TeamsRemoveProjectLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/projects/:project_id" }

Type declaration

TeamsRemoveRepoInOrgEndpoint

TeamsRemoveRepoInOrgEndpoint: { org: string; owner: string; repo: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_slug: string

    team_slug parameter

TeamsRemoveRepoInOrgRequestOptions

TeamsRemoveRepoInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" }

Type declaration

TeamsRemoveRepoLegacyEndpoint

TeamsRemoveRepoLegacyEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsRemoveRepoLegacyRequestOptions

TeamsRemoveRepoLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/repos/:owner/:repo" }

Type declaration

TeamsReviewProjectInOrgEndpoint

TeamsReviewProjectInOrgEndpoint: { org: string; project_id: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • project_id: number

    project_id parameter

  • team_slug: string

    team_slug parameter

TeamsReviewProjectInOrgRequestOptions

TeamsReviewProjectInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects/:project_id" }

Type declaration

TeamsReviewProjectInOrgResponseData

TeamsReviewProjectInOrgResponseData: { body: string; columns_url: string; created_at: string; creator: TeamsReviewProjectInOrgResponseDataCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsReviewProjectInOrgResponseDataPermissions; private: boolean; state: string; updated_at: string; url: string }

Type declaration

TeamsReviewProjectInOrgResponseDataCreator

TeamsReviewProjectInOrgResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsReviewProjectInOrgResponseDataPermissions

TeamsReviewProjectInOrgResponseDataPermissions: { admin: boolean; read: boolean; write: boolean }

Type declaration

  • admin: boolean
  • read: boolean
  • write: boolean

TeamsReviewProjectLegacyEndpoint

TeamsReviewProjectLegacyEndpoint: { project_id: number; team_id: number }

Type declaration

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsReviewProjectLegacyRequestOptions

TeamsReviewProjectLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/projects/:project_id" }

Type declaration

TeamsReviewProjectLegacyResponseData

TeamsReviewProjectLegacyResponseData: { body: string; columns_url: string; created_at: string; creator: TeamsReviewProjectLegacyResponseDataCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsReviewProjectLegacyResponseDataPermissions; private: boolean; state: string; updated_at: string; url: string }

Type declaration

TeamsReviewProjectLegacyResponseDataCreator

TeamsReviewProjectLegacyResponseDataCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsReviewProjectLegacyResponseDataPermissions

TeamsReviewProjectLegacyResponseDataPermissions: { admin: boolean; read: boolean; write: boolean }

Type declaration

  • admin: boolean
  • read: boolean
  • write: boolean

TeamsUpdateDiscussionCommentInOrgEndpoint

TeamsUpdateDiscussionCommentInOrgEndpoint: { body: string; comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsUpdateDiscussionCommentInOrgRequestOptions

TeamsUpdateDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsUpdateDiscussionCommentInOrgResponseData

TeamsUpdateDiscussionCommentInOrgResponseData: { author: TeamsUpdateDiscussionCommentInOrgResponseDataAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; reactions: TeamsUpdateDiscussionCommentInOrgResponseDataReactions; updated_at: string; url: string }

Type declaration

TeamsUpdateDiscussionCommentInOrgResponseDataAuthor

TeamsUpdateDiscussionCommentInOrgResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsUpdateDiscussionCommentInOrgResponseDataReactions

TeamsUpdateDiscussionCommentInOrgResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsUpdateDiscussionCommentLegacyEndpoint

TeamsUpdateDiscussionCommentLegacyEndpoint: { body: string; comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsUpdateDiscussionCommentLegacyRequestOptions

TeamsUpdateDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsUpdateDiscussionCommentLegacyResponseData

TeamsUpdateDiscussionCommentLegacyResponseData: { author: TeamsUpdateDiscussionCommentLegacyResponseDataAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; reactions: TeamsUpdateDiscussionCommentLegacyResponseDataReactions; updated_at: string; url: string }

Type declaration

TeamsUpdateDiscussionCommentLegacyResponseDataAuthor

TeamsUpdateDiscussionCommentLegacyResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsUpdateDiscussionCommentLegacyResponseDataReactions

TeamsUpdateDiscussionCommentLegacyResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsUpdateDiscussionInOrgEndpoint

TeamsUpdateDiscussionInOrgEndpoint: { body?: string; discussion_number: number; org: string; team_slug: string; title?: string }

Type declaration

  • Optional body?: string

    The discussion post's body text.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

  • Optional title?: string

    The discussion post's title.

TeamsUpdateDiscussionInOrgRequestOptions

TeamsUpdateDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" }

Type declaration

TeamsUpdateDiscussionInOrgResponseData

TeamsUpdateDiscussionInOrgResponseData: { author: TeamsUpdateDiscussionInOrgResponseDataAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: string; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsUpdateDiscussionInOrgResponseDataReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsUpdateDiscussionInOrgResponseDataAuthor

TeamsUpdateDiscussionInOrgResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsUpdateDiscussionInOrgResponseDataReactions

TeamsUpdateDiscussionInOrgResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsUpdateDiscussionLegacyEndpoint

TeamsUpdateDiscussionLegacyEndpoint: { body?: string; discussion_number: number; team_id: number; title?: string }

Type declaration

  • Optional body?: string

    The discussion post's body text.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

  • Optional title?: string

    The discussion post's title.

TeamsUpdateDiscussionLegacyRequestOptions

TeamsUpdateDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number" }

Type declaration

TeamsUpdateDiscussionLegacyResponseData

TeamsUpdateDiscussionLegacyResponseData: { author: TeamsUpdateDiscussionLegacyResponseDataAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: string; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsUpdateDiscussionLegacyResponseDataReactions; team_url: string; title: string; updated_at: string; url: string }

Type declaration

TeamsUpdateDiscussionLegacyResponseDataAuthor

TeamsUpdateDiscussionLegacyResponseDataAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsUpdateDiscussionLegacyResponseDataReactions

TeamsUpdateDiscussionLegacyResponseDataReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsUpdateInOrgEndpoint

TeamsUpdateInOrgEndpoint: { description?: string; name: string; org: string; parent_team_id?: number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; team_slug: string }

Type declaration

  • Optional description?: string

    The description of the team.

  • name: string

    The name of the team.

  • org: string

    org parameter

  • Optional parent_team_id?: number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_slug: string

    team_slug parameter

TeamsUpdateInOrgRequestOptions

TeamsUpdateInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug" }

Type declaration

TeamsUpdateInOrgResponseData

TeamsUpdateInOrgResponseData: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsUpdateInOrgResponseDataOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • description: string
  • html_url: string
  • id: number
  • members_count: number
  • members_url: string
  • name: string
  • node_id: string
  • organization: TeamsUpdateInOrgResponseDataOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsUpdateInOrgResponseDataOrganization

TeamsUpdateInOrgResponseDataOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • blog: string
  • company: string
  • created_at: string
  • description: string
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • members_url: string
  • name: string
  • node_id: string
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • type: string
  • url: string

TeamsUpdateLegacyEndpoint

TeamsUpdateLegacyEndpoint: { description?: string; name: string; parent_team_id?: number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; team_id: number }

Type declaration

  • Optional description?: string

    The description of the team.

  • name: string

    The name of the team.

  • Optional parent_team_id?: number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_id: number

    team_id parameter

TeamsUpdateLegacyRequestOptions

TeamsUpdateLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id" }

Type declaration

TeamsUpdateLegacyResponseData

TeamsUpdateLegacyResponseData: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsUpdateLegacyResponseDataOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

Type declaration

  • created_at: string
  • description: string
  • html_url: string
  • id: number
  • members_count: number
  • members_url: string
  • name: string
  • node_id: string
  • organization: TeamsUpdateLegacyResponseDataOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsUpdateLegacyResponseDataOrganization

TeamsUpdateLegacyResponseDataOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • blog: string
  • company: string
  • created_at: string
  • description: string
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • members_url: string
  • name: string
  • node_id: string
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • type: string
  • url: string

UsersAddEmailsEndpoint

UsersAddEmailsEndpoint: { emails: string[] }

Type declaration

  • emails: string[]

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

UsersAddEmailsRequestOptions

UsersAddEmailsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/emails" }

Type declaration

UsersAddEmailsResponseData

UsersAddEmailsResponseData: Array<UsersAddEmailsResponseDataItem>

UsersAddEmailsResponseDataItem

UsersAddEmailsResponseDataItem: { email: string; primary: boolean; verified: boolean; visibility: string | null }

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string | null

UsersBlockEndpoint

UsersBlockEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersBlockRequestOptions

UsersBlockRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/blocks/:username" }

Type declaration

UsersCheckBlockedEndpoint

UsersCheckBlockedEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersCheckBlockedRequestOptions

UsersCheckBlockedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/blocks/:username" }

Type declaration

UsersCheckFollowingEndpoint

UsersCheckFollowingEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersCheckFollowingForUserEndpoint

UsersCheckFollowingForUserEndpoint: { target_user: string; username: string }

Type declaration

  • target_user: string

    target_user parameter

  • username: string

    username parameter

UsersCheckFollowingForUserRequestOptions

UsersCheckFollowingForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/following/:target_user" }

Type declaration

UsersCheckFollowingRequestOptions

UsersCheckFollowingRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/following/:username" }

Type declaration

UsersCreateGpgKeyEndpoint

UsersCreateGpgKeyEndpoint: { armored_public_key?: string }

Type declaration

  • Optional armored_public_key?: string

    Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.

UsersCreateGpgKeyRequestOptions

UsersCreateGpgKeyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/gpg_keys" }

Type declaration

UsersCreateGpgKeyResponseData

UsersCreateGpgKeyResponseData: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersCreateGpgKeyResponseDataEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersCreateGpgKeyResponseDataSubkeysItem> }

Type declaration

UsersCreateGpgKeyResponseDataEmailsItem

UsersCreateGpgKeyResponseDataEmailsItem: { email: string; verified: boolean }

Type declaration

  • email: string
  • verified: boolean

UsersCreateGpgKeyResponseDataSubkeysItem

UsersCreateGpgKeyResponseDataSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

Type declaration

  • can_certify: boolean
  • can_encrypt_comms: boolean
  • can_encrypt_storage: boolean
  • can_sign: boolean
  • created_at: string
  • emails: Array<any>
  • expires_at: null
  • id: number
  • key_id: string
  • primary_key_id: number
  • public_key: string
  • subkeys: Array<any>

UsersCreatePublicKeyEndpoint

UsersCreatePublicKeyEndpoint: { key?: string; title?: string }

Type declaration

  • Optional key?: string

    The public SSH key to add to your GitHub account. See "Generating a new SSH key" for guidance on how to create a public SSH key.

  • Optional title?: string

    A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".

UsersCreatePublicKeyRequestOptions

UsersCreatePublicKeyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/keys" }

Type declaration

UsersCreatePublicKeyResponseData

UsersCreatePublicKeyResponseData: { key: string; key_id: string }

Type declaration

  • key: string
  • key_id: string

UsersDeleteEmailsEndpoint

UsersDeleteEmailsEndpoint: { emails: string[] }

Type declaration

  • emails: string[]

    Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

UsersDeleteEmailsRequestOptions

UsersDeleteEmailsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/emails" }

Type declaration

UsersDeleteGpgKeyEndpoint

UsersDeleteGpgKeyEndpoint: { gpg_key_id: number }

Type declaration

  • gpg_key_id: number

    gpg_key_id parameter

UsersDeleteGpgKeyRequestOptions

UsersDeleteGpgKeyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/gpg_keys/:gpg_key_id" }

Type declaration

UsersDeletePublicKeyEndpoint

UsersDeletePublicKeyEndpoint: { key_id: number }

Type declaration

  • key_id: number

    key_id parameter

UsersDeletePublicKeyRequestOptions

UsersDeletePublicKeyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/keys/:key_id" }

Type declaration

UsersFollowEndpoint

UsersFollowEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersFollowRequestOptions

UsersFollowRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/following/:username" }

Type declaration

UsersGetAuthenticatedEndpoint

UsersGetAuthenticatedEndpoint: {}

Type declaration

UsersGetAuthenticatedRequestOptions

UsersGetAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user" }

Type declaration

UsersGetAuthenticatedResponseData

UsersGetAuthenticatedResponseData: { avatar_url: string; bio: string; blog: string; collaborators?: number; company: string; created_at: string; disk_usage?: number; email: string; events_url: string; followers: number; followers_url: string; following: number; following_url: string; gists_url: string; gravatar_id: string; hireable: boolean; html_url: string; id: number; location: string; login: string; name: string; node_id: string; organizations_url: string; owned_private_repos?: number; plan?: UsersGetAuthenticatedResponseDataPlan; private_gists?: number; public_gists: number; public_repos: number; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; total_private_repos?: number; two_factor_authentication?: boolean; type: string; updated_at: string; url: string }

Type declaration

  • avatar_url: string
  • bio: string
  • blog: string
  • Optional collaborators?: number
  • company: string
  • created_at: string
  • Optional disk_usage?: number
  • email: string
  • events_url: string
  • followers: number
  • followers_url: string
  • following: number
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • hireable: boolean
  • html_url: string
  • id: number
  • location: string
  • login: string
  • name: string
  • node_id: string
  • organizations_url: string
  • Optional owned_private_repos?: number
  • Optional plan?: UsersGetAuthenticatedResponseDataPlan
  • Optional private_gists?: number
  • public_gists: number
  • public_repos: number
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • Optional total_private_repos?: number
  • Optional two_factor_authentication?: boolean
  • type: string
  • updated_at: string
  • url: string

UsersGetAuthenticatedResponseDataPlan

UsersGetAuthenticatedResponseDataPlan: { collaborators: number; name: string; private_repos: number; space: number }

Type declaration

  • collaborators: number
  • name: string
  • private_repos: number
  • space: number

UsersGetByUsernameEndpoint

UsersGetByUsernameEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersGetByUsernameRequestOptions

UsersGetByUsernameRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username" }

Type declaration

UsersGetByUsernameResponseData

UsersGetByUsernameResponseData: { avatar_url: string; bio: string; blog: string; company: string; created_at: string; email: string; events_url: string; followers: number; followers_url: string; following: number; following_url: string; gists_url: string; gravatar_id: string; hireable: boolean; html_url: string; id: number; location: string; login: string; name: string; node_id: string; organizations_url: string; plan?: UsersGetByUsernameResponseDataPlan; public_gists: number; public_repos: number; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; updated_at: string; url: string }

Type declaration

  • avatar_url: string
  • bio: string
  • blog: string
  • company: string
  • created_at: string
  • email: string
  • events_url: string
  • followers: number
  • followers_url: string
  • following: number
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • hireable: boolean
  • html_url: string
  • id: number
  • location: string
  • login: string
  • name: string
  • node_id: string
  • organizations_url: string
  • Optional plan?: UsersGetByUsernameResponseDataPlan
  • public_gists: number
  • public_repos: number
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • updated_at: string
  • url: string

UsersGetByUsernameResponseDataPlan

UsersGetByUsernameResponseDataPlan: { collaborators: number; name: string; private_repos: number; space: number }

Type declaration

  • collaborators: number
  • name: string
  • private_repos: number
  • space: number

UsersGetContextForUserEndpoint

UsersGetContextForUserEndpoint: { subject_id?: string; subject_type?: "organization" | "repository" | "issue" | "pull_request"; username: string }

Type declaration

  • Optional subject_id?: string

    Uses the ID for the subject_type you specified. Required when using subject_type.

  • Optional subject_type?: "organization" | "repository" | "issue" | "pull_request"

    Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

  • username: string

    username parameter

UsersGetContextForUserRequestOptions

UsersGetContextForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/hovercard" }

Type declaration

UsersGetContextForUserResponseData

UsersGetContextForUserResponseData: { contexts: Array<UsersGetContextForUserResponseDataContextsItem> }

Type declaration

UsersGetContextForUserResponseDataContextsItem

UsersGetContextForUserResponseDataContextsItem: { message: string; octicon: string }

Type declaration

  • message: string
  • octicon: string

UsersGetGpgKeyEndpoint

UsersGetGpgKeyEndpoint: { gpg_key_id: number }

Type declaration

  • gpg_key_id: number

    gpg_key_id parameter

UsersGetGpgKeyRequestOptions

UsersGetGpgKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/gpg_keys/:gpg_key_id" }

Type declaration

UsersGetGpgKeyResponseData

UsersGetGpgKeyResponseData: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersGetGpgKeyResponseDataEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersGetGpgKeyResponseDataSubkeysItem> }

Type declaration

UsersGetGpgKeyResponseDataEmailsItem

UsersGetGpgKeyResponseDataEmailsItem: { email: string; verified: boolean }

Type declaration

  • email: string
  • verified: boolean

UsersGetGpgKeyResponseDataSubkeysItem

UsersGetGpgKeyResponseDataSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

Type declaration

  • can_certify: boolean
  • can_encrypt_comms: boolean
  • can_encrypt_storage: boolean
  • can_sign: boolean
  • created_at: string
  • emails: Array<any>
  • expires_at: null
  • id: number
  • key_id: string
  • primary_key_id: number
  • public_key: string
  • subkeys: Array<any>

UsersGetPublicKeyEndpoint

UsersGetPublicKeyEndpoint: { key_id: number }

Type declaration

  • key_id: number

    key_id parameter

UsersGetPublicKeyRequestOptions

UsersGetPublicKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/keys/:key_id" }

Type declaration

UsersGetPublicKeyResponseData

UsersGetPublicKeyResponseData: { key: string; key_id: string }

Type declaration

  • key: string
  • key_id: string

UsersListBlockedEndpoint

UsersListBlockedEndpoint: {}

Type declaration

UsersListBlockedRequestOptions

UsersListBlockedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/blocks" }

Type declaration

UsersListBlockedResponseData

UsersListBlockedResponseData: Array<UsersListBlockedResponseDataItem>

UsersListBlockedResponseDataItem

UsersListBlockedResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListEmailsEndpoint

UsersListEmailsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListEmailsRequestOptions

UsersListEmailsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/emails" }

Type declaration

UsersListEmailsResponseData

UsersListEmailsResponseData: Array<UsersListEmailsResponseDataItem>

UsersListEmailsResponseDataItem

UsersListEmailsResponseDataItem: { email: string; primary: boolean; verified: boolean; visibility: string }

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string

UsersListEndpoint

UsersListEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    The integer ID of the last User that you've seen.

UsersListFollowedByAuthenticatedEndpoint

UsersListFollowedByAuthenticatedEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListFollowedByAuthenticatedRequestOptions

UsersListFollowedByAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/following" }

Type declaration

UsersListFollowedByAuthenticatedResponseData

UsersListFollowedByAuthenticatedResponseData: Array<UsersListFollowedByAuthenticatedResponseDataItem>

UsersListFollowedByAuthenticatedResponseDataItem

UsersListFollowedByAuthenticatedResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListFollowersForAuthenticatedUserEndpoint

UsersListFollowersForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListFollowersForAuthenticatedUserRequestOptions

UsersListFollowersForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/followers" }

Type declaration

UsersListFollowersForAuthenticatedUserResponseData

UsersListFollowersForAuthenticatedUserResponseData: Array<UsersListFollowersForAuthenticatedUserResponseDataItem>

UsersListFollowersForAuthenticatedUserResponseDataItem

UsersListFollowersForAuthenticatedUserResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListFollowersForUserEndpoint

UsersListFollowersForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListFollowersForUserRequestOptions

UsersListFollowersForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/followers" }

Type declaration

UsersListFollowersForUserResponseData

UsersListFollowersForUserResponseData: Array<UsersListFollowersForUserResponseDataItem>

UsersListFollowersForUserResponseDataItem

UsersListFollowersForUserResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListFollowingForUserEndpoint

UsersListFollowingForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListFollowingForUserRequestOptions

UsersListFollowingForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/following" }

Type declaration

UsersListFollowingForUserResponseData

UsersListFollowingForUserResponseData: Array<UsersListFollowingForUserResponseDataItem>

UsersListFollowingForUserResponseDataItem

UsersListFollowingForUserResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListGpgKeysEndpoint

UsersListGpgKeysEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListGpgKeysForUserEndpoint

UsersListGpgKeysForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListGpgKeysForUserRequestOptions

UsersListGpgKeysForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/gpg_keys" }

Type declaration

UsersListGpgKeysForUserResponseData

UsersListGpgKeysForUserResponseData: Array<UsersListGpgKeysForUserResponseDataItem>

UsersListGpgKeysForUserResponseDataItem

UsersListGpgKeysForUserResponseDataItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersListGpgKeysForUserResponseDataItemEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersListGpgKeysForUserResponseDataItemSubkeysItem> }

Type declaration

UsersListGpgKeysForUserResponseDataItemEmailsItem

UsersListGpgKeysForUserResponseDataItemEmailsItem: { email: string; verified: boolean }

Type declaration

  • email: string
  • verified: boolean

UsersListGpgKeysForUserResponseDataItemSubkeysItem

UsersListGpgKeysForUserResponseDataItemSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

Type declaration

  • can_certify: boolean
  • can_encrypt_comms: boolean
  • can_encrypt_storage: boolean
  • can_sign: boolean
  • created_at: string
  • emails: Array<any>
  • expires_at: null
  • id: number
  • key_id: string
  • primary_key_id: number
  • public_key: string
  • subkeys: Array<any>

UsersListGpgKeysRequestOptions

UsersListGpgKeysRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/gpg_keys" }

Type declaration

UsersListGpgKeysResponseData

UsersListGpgKeysResponseData: Array<UsersListGpgKeysResponseDataItem>

UsersListGpgKeysResponseDataItem

UsersListGpgKeysResponseDataItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersListGpgKeysResponseDataItemEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersListGpgKeysResponseDataItemSubkeysItem> }

Type declaration

UsersListGpgKeysResponseDataItemEmailsItem

UsersListGpgKeysResponseDataItemEmailsItem: { email: string; verified: boolean }

Type declaration

  • email: string
  • verified: boolean

UsersListGpgKeysResponseDataItemSubkeysItem

UsersListGpgKeysResponseDataItemSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

Type declaration

  • can_certify: boolean
  • can_encrypt_comms: boolean
  • can_encrypt_storage: boolean
  • can_sign: boolean
  • created_at: string
  • emails: Array<any>
  • expires_at: null
  • id: number
  • key_id: string
  • primary_key_id: number
  • public_key: string
  • subkeys: Array<any>

UsersListPublicEmailsEndpoint

UsersListPublicEmailsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListPublicEmailsRequestOptions

UsersListPublicEmailsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/public_emails" }

Type declaration

UsersListPublicEmailsResponseData

UsersListPublicEmailsResponseData: Array<UsersListPublicEmailsResponseDataItem>

UsersListPublicEmailsResponseDataItem

UsersListPublicEmailsResponseDataItem: { email: string; primary: boolean; verified: boolean; visibility: string }

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string

UsersListPublicKeysEndpoint

UsersListPublicKeysEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListPublicKeysForUserEndpoint

UsersListPublicKeysForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListPublicKeysForUserRequestOptions

UsersListPublicKeysForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/keys" }

Type declaration

UsersListPublicKeysForUserResponseData

UsersListPublicKeysForUserResponseData: Array<UsersListPublicKeysForUserResponseDataItem>

UsersListPublicKeysForUserResponseDataItem

UsersListPublicKeysForUserResponseDataItem: { id: number; key: string }

Type declaration

  • id: number
  • key: string

UsersListPublicKeysRequestOptions

UsersListPublicKeysRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/keys" }

Type declaration

UsersListPublicKeysResponseData

UsersListPublicKeysResponseData: Array<UsersListPublicKeysResponseDataItem>

UsersListPublicKeysResponseDataItem

UsersListPublicKeysResponseDataItem: { key: string; key_id: string }

Type declaration

  • key: string
  • key_id: string

UsersListRequestOptions

UsersListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users" }

Type declaration

UsersListResponseData

UsersListResponseData: Array<UsersListResponseDataItem>

UsersListResponseDataItem

UsersListResponseDataItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersTogglePrimaryEmailVisibilityEndpoint

UsersTogglePrimaryEmailVisibilityEndpoint: { email: string; visibility: string }

Type declaration

  • email: string

    Specify the primary email address that needs a visibility change.

  • visibility: string

    Use public to enable an authenticated user to view the specified email address, or use private so this primary email address cannot be seen publicly.

UsersTogglePrimaryEmailVisibilityRequestOptions

UsersTogglePrimaryEmailVisibilityRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user/email/visibility" }

Type declaration

UsersTogglePrimaryEmailVisibilityResponseData

UsersTogglePrimaryEmailVisibilityResponseData: Array<UsersTogglePrimaryEmailVisibilityResponseDataItem>

UsersTogglePrimaryEmailVisibilityResponseDataItem

UsersTogglePrimaryEmailVisibilityResponseDataItem: { email: string; primary: boolean; verified: boolean; visibility: string }

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string

UsersUnblockEndpoint

UsersUnblockEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersUnblockRequestOptions

UsersUnblockRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/blocks/:username" }

Type declaration

UsersUnfollowEndpoint

UsersUnfollowEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersUnfollowRequestOptions

UsersUnfollowRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/following/:username" }

Type declaration

UsersUpdateAuthenticatedEndpoint

UsersUpdateAuthenticatedEndpoint: { bio?: string; blog?: string; company?: string; email?: string; hireable?: boolean; location?: string; name?: string }

Type declaration

  • Optional bio?: string

    The new short biography of the user.

  • Optional blog?: string

    The new blog URL of the user.

  • Optional company?: string

    The new company of the user.

  • Optional email?: string

    The publicly visible email address of the user.

  • Optional hireable?: boolean

    The new hiring availability of the user.

  • Optional location?: string

    The new location of the user.

  • Optional name?: string

    The new name of the user.

UsersUpdateAuthenticatedRequestOptions

UsersUpdateAuthenticatedRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user" }

Type declaration

UsersUpdateAuthenticatedResponseData

UsersUpdateAuthenticatedResponseData: { avatar_url: string; bio: string; blog: string; collaborators: number; company: string; created_at: string; disk_usage: number; email: string; events_url: string; followers: number; followers_url: string; following: number; following_url: string; gists_url: string; gravatar_id: string; hireable: boolean; html_url: string; id: number; location: string; login: string; name: string; node_id: string; organizations_url: string; owned_private_repos: number; plan: UsersUpdateAuthenticatedResponseDataPlan; private_gists: number; public_gists: number; public_repos: number; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; total_private_repos: number; two_factor_authentication: boolean; type: string; updated_at: string; url: string }

Type declaration

  • avatar_url: string
  • bio: string
  • blog: string
  • collaborators: number
  • company: string
  • created_at: string
  • disk_usage: number
  • email: string
  • events_url: string
  • followers: number
  • followers_url: string
  • following: number
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • hireable: boolean
  • html_url: string
  • id: number
  • location: string
  • login: string
  • name: string
  • node_id: string
  • organizations_url: string
  • owned_private_repos: number
  • plan: UsersUpdateAuthenticatedResponseDataPlan
  • private_gists: number
  • public_gists: number
  • public_repos: number
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • total_private_repos: number
  • two_factor_authentication: boolean
  • type: string
  • updated_at: string
  • url: string

UsersUpdateAuthenticatedResponseDataPlan

UsersUpdateAuthenticatedResponseDataPlan: { collaborators: number; name: string; private_repos: number; space: number }

Type declaration

  • collaborators: number
  • name: string
  • private_repos: number
  • space: number

Generated using TypeDoc